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



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
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 128

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

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

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

  if attributes.key?(:'Alignment')
    self.alignment = attributes[:'Alignment']
  end

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

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

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

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

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

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

Instance Attribute Details

#alignment ⇒ Object

Gets or sets the justification of the actual number of the list item. The list label is justified relative to the Aspose.Words.Lists.ListLevel.NumberPosition property.



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

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.



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

def is_legal
  @is_legal
end

#number_format ⇒ Object

Gets or sets the number format for the list level. Among normal text characters, the string can contain placeholder characters \x0000 to \x0008 representing the numbers from the corresponding list levels. For example, the string “\x0000.\x0001)” will generate a list label that looks something like “1.5)”. The number “1” is the current number from the 1st list level, the number “5” is the current number from the 2nd list level. Null is not allowed, but an empty string meaning no number is valid.



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

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. Aspose.Words.Lists.ListLevel.NumberPosition corresponds to LeftIndent plus FirstLineIndent of the paragraph. Aspose.Words.Lists.ListLevel.TextPosition Aspose.Words.Lists.ListLevel.TabPosition.



65
66
67
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 65

def number_position
  @number_position
end

#number_style ⇒ Object

Gets or sets the number style for this list level.



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

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. The value of -1 means the numbering will continue.



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

def restart_after_level
  @restart_after_level
end

#start_at ⇒ Object

Gets or sets the starting number for this list level. Default value is 1.



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

def start_at
  @start_at
end

#tab_position ⇒ Object

Gets or sets the tab position (in points) for the list level. Has effect only when Aspose.Words.Lists.ListLevel.TrailingCharacter is a tab. Aspose.Words.Lists.ListLevel.NumberPosition Aspose.Words.Lists.ListLevel.TextPosition.



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

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. Aspose.Words.Lists.ListLevel.TextPosition corresponds to LeftIndent of the paragraph. Aspose.Words.Lists.ListLevel.NumberPosition Aspose.Words.Lists.ListLevel.TabPosition.



70
71
72
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 70

def text_position
  @text_position
end

#trailing_character ⇒ Object

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



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

def trailing_character
  @trailing_character
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 95

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

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 111

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 233

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



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
320
321
322
323
324
325
326
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 285

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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 356

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



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

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 



370
371
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 370

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 250

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 256

def hash
  [start_at, number_style, number_format, alignment, is_legal, restart_after_level, trailing_character, tab_position, number_position, text_position].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



336
337
338
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 336

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



342
343
344
345
346
347
348
349
350
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 342

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



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

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



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 177

def valid?
  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)
  alignment_validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right"])
  return false unless alignment_validator.valid?(@alignment)
  trailing_character_validator = EnumAttributeValidator.new('String', ["Tab", "Space", "Nothing"])
  return false unless trailing_character_validator.valid?(@trailing_character)

  return true
end

#validate ⇒ Object 



373
374
 
# File 'lib/aspose_words_cloud/models/list_level_update.rb', line 373

def validate()
end