Class: AsposeWordsCloud::TableCellFormat

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

Overview

DTO container with all formatting for a table row.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TableCellFormat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 133

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

  if attributes.key?(:'BottomPadding')
    self.bottom_padding = attributes[:'BottomPadding']
  end

  if attributes.key?(:'FitText')
    self.fit_text = attributes[:'FitText']
  end

  if attributes.key?(:'HorizontalMerge')
    self.horizontal_merge = attributes[:'HorizontalMerge']
  end

  if attributes.key?(:'LeftPadding')
    self.left_padding = attributes[:'LeftPadding']
  end

  if attributes.key?(:'Orientation')
    self.orientation = attributes[:'Orientation']
  end

  if attributes.key?(:'PreferredWidth')
    self.preferred_width = attributes[:'PreferredWidth']
  end

  if attributes.key?(:'RightPadding')
    self.right_padding = attributes[:'RightPadding']
  end

  if attributes.key?(:'TopPadding')
    self.top_padding = attributes[:'TopPadding']
  end

  if attributes.key?(:'VerticalAlignment')
    self.vertical_alignment = attributes[:'VerticalAlignment']
  end

  if attributes.key?(:'VerticalMerge')
    self.vertical_merge = attributes[:'VerticalMerge']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'WrapText')
    self.wrap_text = attributes[:'WrapText']
  end
end

Instance Attribute Details

#bottom_padding ⇒ Object

Gets or sets the amount of space (in points) to add below the contents of the cell.



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

def bottom_padding
  @bottom_padding
end

#fit_text ⇒ Object

Gets or sets a value indicating whether to fit text in the cell, compress each paragraph to the width of the cell.



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

def fit_text
  @fit_text
end

#horizontal_merge ⇒ Object

Gets or sets the option that controls how the cell is merged horizontally with other cells in the row.



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

def horizontal_merge
  @horizontal_merge
end

#left_padding ⇒ Object

Gets or sets the amount of space (in points) to add to the left of the contents of the cell.



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

def left_padding
  @left_padding
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#orientation ⇒ Object

Gets or sets the orientation of text in a table cell.



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

def orientation
  @orientation
end

#preferred_width ⇒ Object

Gets or sets the preferred width of the cell.



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

def preferred_width
  @preferred_width
end

#right_padding ⇒ Object

Gets or sets the amount of space (in points) to add to the right of the contents of the cell.



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

def right_padding
  @right_padding
end

#top_padding ⇒ Object

Gets or sets the amount of space (in points) to add above the contents of the cell.



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

def top_padding
  @top_padding
end

#vertical_alignment ⇒ Object

Gets or sets the vertical alignment of text in the cell.



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

def vertical_alignment
  @vertical_alignment
end

#vertical_merge ⇒ Object

Gets or sets the option that controls how the cell is merged with other cells vertically.



63
64
65
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 63

def vertical_merge
  @vertical_merge
end

#width ⇒ Object

Gets or sets the width of the cell in points.



66
67
68
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 66

def width
  @width
end

#wrap_text ⇒ Object

Gets or sets a value indicating whether to wrap text in the cell.



69
70
71
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 69

def wrap_text
  @wrap_text
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'link' => :'Link',
    :'bottom_padding' => :'BottomPadding',
    :'fit_text' => :'FitText',
    :'horizontal_merge' => :'HorizontalMerge',
    :'left_padding' => :'LeftPadding',
    :'orientation' => :'Orientation',
    :'preferred_width' => :'PreferredWidth',
    :'right_padding' => :'RightPadding',
    :'top_padding' => :'TopPadding',
    :'vertical_alignment' => :'VerticalAlignment',
    :'vertical_merge' => :'VerticalMerge',
    :'width' => :'Width',
    :'wrap_text' => :'WrapText'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 113

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'bottom_padding' => :'Float',
    :'fit_text' => :'BOOLEAN',
    :'horizontal_merge' => :'String',
    :'left_padding' => :'Float',
    :'orientation' => :'String',
    :'preferred_width' => :'PreferredWidth',
    :'right_padding' => :'Float',
    :'top_padding' => :'Float',
    :'vertical_alignment' => :'String',
    :'vertical_merge' => :'String',
    :'width' => :'Float',
    :'wrap_text' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 273

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      bottom_padding == other.bottom_padding &&
      fit_text == other.fit_text &&
      horizontal_merge == other.horizontal_merge &&
      left_padding == other.left_padding &&
      orientation == other.orientation &&
      preferred_width == other.preferred_width &&
      right_padding == other.right_padding &&
      top_padding == other.top_padding &&
      vertical_alignment == other.vertical_alignment &&
      vertical_merge == other.vertical_merge &&
      width == other.width &&
      wrap_text == other.wrap_text
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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 328

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 395

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 306

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


293
294
295
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 293

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 299

def hash
  [link, bottom_padding, fit_text, horizontal_merge, left_padding, orientation, preferred_width, right_padding, top_padding, vertical_alignment, vertical_merge, width, wrap_text].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



194
195
196
197
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 194

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



375
376
377
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 375

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



381
382
383
384
385
386
387
388
389
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 381

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



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

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



201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 201

def valid?
  horizontal_merge_validator = EnumAttributeValidator.new('String', ["None", "First", "Previous"])
  return false unless horizontal_merge_validator.valid?(@horizontal_merge)
  orientation_validator = EnumAttributeValidator.new('String', ["Horizontal", "Downward", "Upward", "HorizontalRotatedFarEast", "VerticalFarEast", "VerticalRotatedFarEast"])
  return false unless orientation_validator.valid?(@orientation)
  vertical_alignment_validator = EnumAttributeValidator.new('String', ["Top", "Center", "Bottom"])
  return false unless vertical_alignment_validator.valid?(@vertical_alignment)
  vertical_merge_validator = EnumAttributeValidator.new('String', ["None", "First", "Previous"])
  return false unless vertical_merge_validator.valid?(@vertical_merge)

  return true
end