Class: AsposeWordsCloud::TabStop

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

Overview

DTO container with paragraph format tab stop.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TabStop

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 88

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

  if attributes.key?(:'Position')
    self.position = attributes[:'Position']
  end

  if attributes.key?(:'IsClear')
    self.is_clear = attributes[:'IsClear']
  end
end

Instance Attribute Details

#alignment ⇒ Object

Gets or sets the alignment of text at this tab stop.



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

def alignment
  @alignment
end

#is_clear ⇒ Object

Gets or sets a value indicating whether this tab stop clears any existing tab stops in this position.



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

def is_clear
  @is_clear
end

#leader ⇒ Object

Gets or sets the type of the leader line displayed under the tab character.



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

def leader
  @leader
end

#position ⇒ Object

Gets or sets the position of the tab stop in points.



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

def position
  @position
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'alignment' => :'Alignment',
    :'leader' => :'Leader',
    :'position' => :'Position',
    :'is_clear' => :'IsClear'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 77

def self.swagger_types
  {
    :'alignment' => :'String',
    :'leader' => :'String',
    :'position' => :'Float',
    :'is_clear' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 153

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      alignment == other.alignment &&
      leader == other.leader &&
      position == other.position &&
      is_clear == other.is_clear
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 199

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 270

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 177

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 



284
285
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 284

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


164
165
166
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 170

def hash
  [alignment, leader, position, is_clear].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



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

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



256
257
258
259
260
261
262
263
264
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 256

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



244
245
246
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 244

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



113
114
115
116
117
118
119
120
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 113

def valid?
  alignment_validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right", "Decimal", "Bar", "List", "Clear"])
  return false unless alignment_validator.valid?(@alignment)
  leader_validator = EnumAttributeValidator.new('String', ["None", "Dots", "Dashes", "Line", "Heavy", "MiddleDot"])
  return false unless leader_validator.valid?(@leader)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


287
288
289
290
291
292
 
# File 'lib/aspose_words_cloud/models/tab_stop.rb', line 287

def validate()
  raise ArgumentError, 'Property alignment in TabStop is required.' if self.alignment.nil?
  raise ArgumentError, 'Property leader in TabStop is required.' if self.leader.nil?
  raise ArgumentError, 'Property position in TabStop is required.' if self.position.nil?
  raise ArgumentError, 'Property is_clear in TabStop is required.' if self.is_clear.nil?
end