Class: AsposeWordsCloud::ListLevelUpdate

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

Overview

Represents a document list levels.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListLevelUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 118

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

  if attributes.key?(:'IsLegal')
    self.is_legal = attributes[:'IsLegal']
  end

  if attributes.key?(:'NumberFormat')
    self.number_format = attributes[:'NumberFormat']
  end

  if attributes.key?(:'NumberPosition')
    self.number_position = attributes[:'NumberPosition']
  end

  if attributes.key?(:'NumberStyle')
    self.number_style = attributes[:'NumberStyle']
  end

  if attributes.key?(:'RestartAfterLevel')
    self.restart_after_level = attributes[:'RestartAfterLevel']
  end

  if attributes.key?(:'StartAt')
    self.start_at = attributes[:'StartAt']
  end

  if attributes.key?(:'TabPosition')
    self.tab_position = attributes[:'TabPosition']
  end

  if attributes.key?(:'TextPosition')
    self.text_position = attributes[:'TextPosition']
  end

  if attributes.key?(:'TrailingCharacter')
    self.trailing_character = attributes[:'TrailingCharacter']
  end
end

Instance Attribute Details

#alignment ⇒ Object

Gets or sets the justification of the actual number of the list item.



33
34
35
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 33

def alignment
  @alignment
end

#is_legal ⇒ Object

Gets or sets a value indicating whether the level turns all inherited numbers to Arabic, false if it preserves their number style.



36
37
38
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 36

def is_legal
  @is_legal
end

#number_format ⇒ Object

Gets or sets the number format for the list level.



39
40
41
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 39

def number_format
  @number_format
end

#number_position ⇒ Object

Gets or sets the position (in points) of the number or bullet for the list level.



42
43
44
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 42

def number_position
  @number_position
end

#number_style ⇒ Object

Gets or sets the number style for this list level.



45
46
47
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 45

def number_style
  @number_style
end

#restart_after_level ⇒ Object

Gets or sets the list level that must appear before the specified list level restarts numbering.



48
49
50
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 48

def restart_after_level
  @restart_after_level
end

#start_at ⇒ Object

Gets or sets the starting number for this list level.



51
52
53
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 51

def start_at
  @start_at
end

#tab_position ⇒ Object

Gets or sets the tab position (in points) for the list level.



54
55
56
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 54

def tab_position
  @tab_position
end

#text_position ⇒ Object

Gets or sets the position (in points) for the second line of wrapping text for the list level.



57
58
59
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 57

def text_position
  @text_position
end

#trailing_character ⇒ Object

Gets or sets the character to be inserted after the number for the list level.



60
61
62
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 60

def trailing_character
  @trailing_character
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 85

def self.attribute_map
  {
    :'alignment' => :'Alignment',
    :'is_legal' => :'IsLegal',
    :'number_format' => :'NumberFormat',
    :'number_position' => :'NumberPosition',
    :'number_style' => :'NumberStyle',
    :'restart_after_level' => :'RestartAfterLevel',
    :'start_at' => :'StartAt',
    :'tab_position' => :'TabPosition',
    :'text_position' => :'TextPosition',
    :'trailing_character' => :'TrailingCharacter'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 101

def self.swagger_types
  {
    :'alignment' => :'String',
    :'is_legal' => :'BOOLEAN',
    :'number_format' => :'String',
    :'number_position' => :'Float',
    :'number_style' => :'String',
    :'restart_after_level' => :'Integer',
    :'start_at' => :'Integer',
    :'tab_position' => :'Float',
    :'text_position' => :'Float',
    :'trailing_character' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 230

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      alignment == other.alignment &&
      is_legal == other.is_legal &&
      number_format == other.number_format &&
      number_position == other.number_position &&
      number_style == other.number_style &&
      restart_after_level == other.restart_after_level &&
      start_at == other.start_at &&
      tab_position == other.tab_position &&
      text_position == other.text_position &&
      trailing_character == other.trailing_character
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 282

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 349

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 260

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

#collectFilesContent(resultFilesContent) ⇒ Object 



363
364
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 363

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


247
248
249
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 247

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 253

def hash
  [alignment, is_legal, number_format, number_position, number_style, restart_after_level, start_at, tab_position, text_position, trailing_character].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



167
168
169
170
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 167

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



329
330
331
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 329

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



335
336
337
338
339
340
341
342
343
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 335

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



323
324
325
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 323

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



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 174

def valid?
  alignment_validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right"])
  return false unless alignment_validator.valid?(@alignment)
  number_style_validator = EnumAttributeValidator.new('String', ["Arabic", "UppercaseRoman", "LowercaseRoman", "UppercaseLetter", "LowercaseLetter", "Ordinal", "Number", "OrdinalText", "Hex", "ChicagoManual", "Kanji", "KanjiDigit", "AiueoHalfWidth", "IrohaHalfWidth", "ArabicFullWidth", "ArabicHalfWidth", "KanjiTraditional", "KanjiTraditional2", "NumberInCircle", "DecimalFullWidth", "Aiueo", "Iroha", "LeadingZero", "Bullet", "Ganada", "Chosung", "GB1", "GB2", "GB3", "GB4", "Zodiac1", "Zodiac2", "Zodiac3", "TradChinNum1", "TradChinNum2", "TradChinNum3", "TradChinNum4", "SimpChinNum1", "SimpChinNum2", "SimpChinNum3", "SimpChinNum4", "HanjaRead", "HanjaReadDigit", "Hangul", "Hanja", "Hebrew1", "Arabic1", "Hebrew2", "Arabic2", "HindiLetter1", "HindiLetter2", "HindiArabic", "HindiCardinalText", "ThaiLetter", "ThaiArabic", "ThaiCardinalText", "VietCardinalText", "NumberInDash", "LowercaseRussian", "UppercaseRussian", "None", "Custom"])
  return false unless number_style_validator.valid?(@number_style)
  trailing_character_validator = EnumAttributeValidator.new('String', ["Tab", "Space", "Nothing"])
  return false unless trailing_character_validator.valid?(@trailing_character)

  return true
end