Class: AsposeWordsCloud::OutlineOptionsData

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/outline_options_data.rb

Overview

container class for outline options.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OutlineOptionsData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 79

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?(:'BookmarksOutlineLevels')
    if (value = attributes[:'BookmarksOutlineLevels']).is_a?(Array)
      self.bookmarks_outline_levels = value
    end
  end

  if attributes.key?(:'DefaultBookmarksOutlineLevel')
    self.default_bookmarks_outline_level = attributes[:'DefaultBookmarksOutlineLevel']
  end

  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?(:'ExpandedOutlineLevels')
    self.expanded_outline_levels = attributes[:'ExpandedOutlineLevels']
  end

  if attributes.key?(:'HeadingsOutlineLevels')
    self.headings_outline_levels = attributes[:'HeadingsOutlineLevels']
  end

end

Instance Attribute Details

#bookmarks_outline_levels ⇒ Object

Gets or sets allows to specify individual bookmarks outline level.



35
36
37
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 35

def bookmarks_outline_levels
  @bookmarks_outline_levels
end

#create_missing_outline_levels ⇒ Object

Gets or sets a value determining whether or not to create missing outline levels when the document is exported. Default value for this property is false.



41
42
43
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 41

def create_missing_outline_levels
  @create_missing_outline_levels
end

#create_outlines_for_headings_in_tables ⇒ Object

Gets or sets specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.



44
45
46
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 44

def create_outlines_for_headings_in_tables
  @create_outlines_for_headings_in_tables
end

#default_bookmarks_outline_level ⇒ Object

Gets or sets specifies the default level in the document outline at which to display Word bookmarks.



38
39
40
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 38

def default_bookmarks_outline_level
  @default_bookmarks_outline_level
end

#expanded_outline_levels ⇒ Object

Gets or sets specifies how many levels in the document outline to show expanded when the file is viewed.



47
48
49
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 47

def expanded_outline_levels
  @expanded_outline_levels
end

#headings_outline_levels ⇒ Object

Gets or sets specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.



50
51
52
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 50

def headings_outline_levels
  @headings_outline_levels
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 54

def self.attribute_map
  {
    :'bookmarks_outline_levels' => :'BookmarksOutlineLevels',
    :'default_bookmarks_outline_level' => :'DefaultBookmarksOutlineLevel',
    :'create_missing_outline_levels' => :'CreateMissingOutlineLevels',
    :'create_outlines_for_headings_in_tables' => :'CreateOutlinesForHeadingsInTables',
    :'expanded_outline_levels' => :'ExpandedOutlineLevels',
    :'headings_outline_levels' => :'HeadingsOutlineLevels'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 66

def self.swagger_types
  {
    :'bookmarks_outline_levels' => :'Array<BookmarksOutlineLevelData>',
    :'default_bookmarks_outline_level' => :'Integer',
    :'create_missing_outline_levels' => :'BOOLEAN',
    :'create_outlines_for_headings_in_tables' => :'BOOLEAN',
    :'expanded_outline_levels' => :'Integer',
    :'headings_outline_levels' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 128

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      bookmarks_outline_levels == other.bookmarks_outline_levels &&
      default_bookmarks_outline_level == other.default_bookmarks_outline_level &&
      create_missing_outline_levels == other.create_missing_outline_levels &&
      create_outlines_for_headings_in_tables == other.create_outlines_for_headings_in_tables &&
      expanded_outline_levels == other.expanded_outline_levels &&
      headings_outline_levels == other.headings_outline_levels
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 176

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<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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
    temp_model = AsposeWordsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 243

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 154

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 147

def hash
  [bookmarks_outline_levels, default_bookmarks_outline_level, create_missing_outline_levels, create_outlines_for_headings_in_tables, expanded_outline_levels, headings_outline_levels].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



115
116
117
118
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 115

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 223

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 229

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



217
218
219
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 217

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



122
123
124
 
# File 'lib/aspose_words_cloud/models/outline_options_data.rb', line 122

def valid?
  return true
end