Class: AsposeWordsCloud::HeaderFooter

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

Overview

DTO container with a section element.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeaderFooter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 93

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

  if attributes.key?(:'ChildNodes')
    if (value = attributes[:'ChildNodes']).is_a?(Array)
      self.child_nodes = value
    end
  end

  if attributes.key?(:'Paragraphs')
    self.paragraphs = attributes[:'Paragraphs']
  end

  if attributes.key?(:'DrawingObjects')
    self.drawing_objects = attributes[:'DrawingObjects']
  end
end

Instance Attribute Details

#child_nodes ⇒ Object

Gets or sets the child nodes.



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

def child_nodes
  @child_nodes
end

#drawing_objects ⇒ Object

Gets or sets the link to DrawingObjects resource.



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

def drawing_objects
  @drawing_objects
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#paragraphs ⇒ Object

Gets or sets the link to Paragraphs resource.



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

def paragraphs
  @paragraphs
end

#type ⇒ Object

Gets or sets the paragraph’s text.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 70

def self.attribute_map
  {
    :'link' => :'Link',
    :'type' => :'Type',
    :'child_nodes' => :'ChildNodes',
    :'paragraphs' => :'Paragraphs',
    :'drawing_objects' => :'DrawingObjects'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'type' => :'String',
    :'child_nodes' => :'Array<NodeLink>',
    :'paragraphs' => :'LinkElement',
    :'drawing_objects' => :'LinkElement'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
156
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 148

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      type == other.type &&
      child_nodes == other.child_nodes &&
      paragraphs == other.paragraphs &&
      drawing_objects == other.drawing_objects
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



195
196
197
198
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
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 195

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



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

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 173

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 



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

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


160
161
162
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 166

def hash
  [link, type, child_nodes, paragraphs, drawing_objects].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



246
247
248
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 246

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 252

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



240
241
242
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 240

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



124
125
126
127
128
129
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 124

def valid?
  type_validator = EnumAttributeValidator.new('String', ["HeaderEven", "HeaderPrimary", "FooterEven", "FooterPrimary", "HeaderFirst", "FooterFirst"])
  return false unless type_validator.valid?(@type)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aspose_words_cloud/models/header_footer.rb', line 283

def validate()
  raise ArgumentError, 'Property type in HeaderFooter is required.' if self.type.nil?
  unless self.link.nil?
      self.link.validate
  end
  unless self.child_nodes.nil?
      for elementChildNodes in self.child_nodes
          unless elementChildNodes.nil?
              elementChildNodes.validate
          end
      end
  end
  unless self.paragraphs.nil?
      self.paragraphs.validate
  end
  unless self.drawing_objects.nil?
      self.drawing_objects.validate
  end

end