# ------------------------------------------------------------------------------------
#
# Copyright (c) 2023 Aspose.Words for Cloud
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# ------------------------------------------------------------------------------------
require 'date'
module AsposeWordsCloud
# Container class for outline options.
class OutlineOptionsData
# Gets or sets a value indicating whether to create missing outline levels when the document is exported. The default value is false.
attr_accessor :create_missing_outline_levels
# Gets or sets a value indicating whether to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.
# The default value is false.
attr_accessor :create_outlines_for_headings_in_tables
# Gets or sets the default level in the document outline at which to display Word bookmarks.
attr_accessor :default_bookmarks_outline_level
# Gets or sets the number of levels in the document outline to show expanded when the file is viewed.
attr_accessor :expanded_outline_levels
# Gets or sets the number of levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.
attr_accessor :headings_outline_levels
# Gets or sets the individual bookmarks outline level.
attr_accessor :bookmarks_outline_levels
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'create_missing_outline_levels' => :'CreateMissingOutlineLevels',
:'create_outlines_for_headings_in_tables' => :'CreateOutlinesForHeadingsInTables',
:'default_bookmarks_outline_level' => :'DefaultBookmarksOutlineLevel',
:'expanded_outline_levels' => :'ExpandedOutlineLevels',
:'headings_outline_levels' => :'HeadingsOutlineLevels',
:'bookmarks_outline_levels' => :'BookmarksOutlineLevels'
}
end
# Attribute type mapping.
def self.swagger_types
{
:'create_missing_outline_levels' => :'BOOLEAN',
:'create_outlines_for_headings_in_tables' => :'BOOLEAN',
:'default_bookmarks_outline_level' => :'Integer',
:'expanded_outline_levels' => :'Integer',
:'headings_outline_levels' => :'Integer',
:'bookmarks_outline_levels' => :'Array'
}
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
return unless attributes.is_a?(Hash)
# convert string to symbol for hash key
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
if attributes.key?(:'CreateMissingOutlineLevels')
self.create_missing_outline_levels = attributes[:'CreateMissingOutlineLevels']
end
if attributes.key?(:'CreateOutlinesForHeadingsInTables')
self.create_outlines_for_headings_in_tables = attributes[:'CreateOutlinesForHeadingsInTables']
end
if attributes.key?(:'DefaultBookmarksOutlineLevel')
self.default_bookmarks_outline_level = attributes[:'DefaultBookmarksOutlineLevel']
end
if attributes.key?(:'ExpandedOutlineLevels')
self.expanded_outline_levels = attributes[:'ExpandedOutlineLevels']
end
if attributes.key?(:'HeadingsOutlineLevels')
self.headings_outline_levels = attributes[:'HeadingsOutlineLevels']
end
if attributes.key?(:'BookmarksOutlineLevels')
if (value = attributes[:'BookmarksOutlineLevels']).is_a?(Array)
self.bookmarks_outline_levels = value
end
end
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
return true
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(other)
return true if self.equal?(other)
self.class == other.class &&
create_missing_outline_levels == other.create_missing_outline_levels &&
create_outlines_for_headings_in_tables == other.create_outlines_for_headings_in_tables &&
default_bookmarks_outline_level == other.default_bookmarks_outline_level &&
expanded_outline_levels == other.expanded_outline_levels &&
headings_outline_levels == other.headings_outline_levels &&
bookmarks_outline_levels == other.bookmarks_outline_levels
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(other)
self == other
end
# Calculates hash code according to all attributes.
# @return [Fixnum] Hash code
def hash
[create_missing_outline_levels, create_outlines_for_headings_in_tables, default_bookmarks_outline_level, expanded_outline_levels, headings_outline_levels, bookmarks_outline_levels].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def build_from_hash(attributes)
return nil unless attributes.is_a?(Hash)
self.class.swagger_types.each_pair do |key, type|
if type =~ /\AArray<(.*)>/i
# check to ensure the input is an array given that the the attribute
# is documented as an array but the input is not
if attributes[self.class.attribute_map[key]].is_a?(Array)
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
end
elsif !attributes[self.class.attribute_map[key]].nil?
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
end
# or else data not found in attributes(hash), not an issue as the data can be optional
end
self
end
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
def _deserialize(type, value)
case type.to_sym
when :DateTime
Time.at(/\d/.match(value)[0].to_f).to_datetime
when :Date
Time.at(/\d/.match(value)[0].to_f).to_date
when :String
value.to_s
when :Integer
value.to_i
when :Float
value.to_f
when :BOOLEAN
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
true
else
false
end
when :Object
# generic object (usually a Hash), return directly
value
when /\AArray<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\z/
k_type = Regexp.last_match[:k_type]
v_type = Regexp.last_match[:v_type]
{}.tap do |hash|
value.each do |k, v|
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
end
end
else
# model
if value[:'$type']
type = value[:'$type'][0..-4]
end
temp_model = AsposeWordsCloud.const_get(type).new
temp_model.build_from_hash(value)
end
end
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
def to_hash
hash = {}
self.class.attribute_map.each_pair do |attr, param|
value = self.send(attr)
next if value.nil?
hash[param] = _to_hash(value)
end
hash
end
# Outputs non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
# @param [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
def _to_hash(value)
if value.is_a?(Array)
value.compact.map { |v| _to_hash(v) }
elsif value.is_a?(Hash)
{}.tap do |hash|
value.each { |k, v| hash[k] = _to_hash(v) }
end
elsif value.respond_to? :to_hash
value.to_hash
else
value
end
end
def collectFilesContent(resultFilesContent)
end
def validate()
unless self.bookmarks_outline_levels.nil?
for elementBookmarksOutlineLevels in self.bookmarks_outline_levels
unless elementBookmarksOutlineLevels.nil?
elementBookmarksOutlineLevels.validate
end
end
end
end
end
end