Class: AsposeWordsCloud::Border

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

Overview

Represents a border of an object. Borders can be applied to various document elements including paragraph, run of text inside a paragraph or a table cell.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Border

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/aspose_words_cloud/models/border.rb', line 108

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

  if attributes.key?(:'Color')
    self.color = attributes[:'Color']
  end

  if attributes.key?(:'DistanceFromText')
    self.distance_from_text = attributes[:'DistanceFromText']
  end

  if attributes.key?(:'LineStyle')
    self.line_style = attributes[:'LineStyle']
  end

  if attributes.key?(:'LineWidth')
    self.line_width = attributes[:'LineWidth']
  end

  if attributes.key?(:'Shadow')
    self.shadow = attributes[:'Shadow']
  end
end

Instance Attribute Details

#border_type ⇒ Object

Gets or sets the border type.



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

def border_type
  @border_type
end

#color ⇒ Object

Gets or sets the border color.



40
41
42
 
# File 'lib/aspose_words_cloud/models/border.rb', line 40

def color
  @color
end

#distance_from_text ⇒ Object

Gets or sets the distance of the border from text or from the page edge in points. Has no effect and will be automatically reset to zero for borders of table cells.



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

def distance_from_text
  @distance_from_text
end

#line_style ⇒ Object

Gets or sets the border style. If you set line style to none, then line width is automatically changed to zero.



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

def line_style
  @line_style
end

#line_width ⇒ Object

Gets or sets the border width in points. If you set line width greater than zero when line style is none, the line style is automatically changed to single line.



52
53
54
 
# File 'lib/aspose_words_cloud/models/border.rb', line 52

def line_width
  @line_width
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#shadow ⇒ Object

Gets or sets a value indicating whether the border has a shadow. In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.



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

def shadow
  @shadow
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_words_cloud/models/border.rb', line 81

def self.attribute_map
  {
    :'link' => :'Link',
    :'border_type' => :'BorderType',
    :'color' => :'Color',
    :'distance_from_text' => :'DistanceFromText',
    :'line_style' => :'LineStyle',
    :'line_width' => :'LineWidth',
    :'shadow' => :'Shadow'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/aspose_words_cloud/models/border.rb', line 94

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'border_type' => :'String',
    :'color' => :'XmlColor',
    :'distance_from_text' => :'Float',
    :'line_style' => :'String',
    :'line_width' => :'Float',
    :'shadow' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/aspose_words_cloud/models/border.rb', line 185

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      border_type == other.border_type &&
      color == other.color &&
      distance_from_text == other.distance_from_text &&
      line_style == other.line_style &&
      line_width == other.line_width &&
      shadow == other.shadow
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aspose_words_cloud/models/border.rb', line 234

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/aspose_words_cloud/models/border.rb', line 305

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/aspose_words_cloud/models/border.rb', line 212

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 



319
320
 
# File 'lib/aspose_words_cloud/models/border.rb', line 319

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/aspose_words_cloud/models/border.rb', line 199

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/aspose_words_cloud/models/border.rb', line 205

def hash
  [link, border_type, color, distance_from_text, line_style, line_width, shadow].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



285
286
287
 
# File 'lib/aspose_words_cloud/models/border.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/aspose_words_cloud/models/border.rb', line 291

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



279
280
281
 
# File 'lib/aspose_words_cloud/models/border.rb', line 279

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



145
146
147
148
149
150
151
152
 
# File 'lib/aspose_words_cloud/models/border.rb', line 145

def valid?
  border_type_validator = EnumAttributeValidator.new('String', ["Bottom", "Left", "Right", "Top", "Horizontal", "Vertical", "DiagonalDown", "DiagonalUp", "None"])
  return false unless border_type_validator.valid?(@border_type)
  line_style_validator = EnumAttributeValidator.new('String', ["None", "Single", "Thick", "Double", "Hairline", "Dot", "DashLargeGap", "DotDash", "DotDotDash", "Triple", "ThinThickSmallGap", "ThickThinSmallGap", "ThinThickThinSmallGap", "ThinThickMediumGap", "ThickThinMediumGap", "ThinThickThinMediumGap", "ThinThickLargeGap", "ThickThinLargeGap", "ThinThickThinLargeGap", "Wave", "DoubleWave", "DashSmallGap", "DashDotStroker", "Emboss3D", "Engrave3D", "Outset", "Inset"])
  return false unless line_style_validator.valid?(@line_style)

  return true
end

#validate ⇒ Object 



322
323
324
325
326
327
328
329
330
 
# File 'lib/aspose_words_cloud/models/border.rb', line 322

def validate()
  unless self.link.nil?
      self.link.validate
  end
  unless self.color.nil?
      self.color.validate
  end

end