Class: AsposeWordsCloud::Footnote

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

Overview

DTO container with a footnote.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Footnote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
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
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 106

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

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

  if attributes.key?(:'FootnoteType')
    self.footnote_type = attributes[:'FootnoteType']
  end

  if attributes.key?(:'ReferenceMark')
    self.reference_mark = attributes[:'ReferenceMark']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end

  if attributes.key?(:'Content')
    self.content = attributes[:'Content']
  end
end

Instance Attribute Details

#content ⇒ Object

Gets or sets the content of the footnote.



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

def content
  @content
end

#footnote_type ⇒ Object

Gets or sets the value, that specifies whether this is a footnote or endnote.



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

def footnote_type
  @footnote_type
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#node_id ⇒ Object

Gets or sets the node id.



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

def node_id
  @node_id
end

#position ⇒ Object

Gets or sets the link to comment range start node.



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

def position
  @position
end

#reference_mark ⇒ Object

Gets or sets the custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used. RTF-format can only store 1 symbol as custom reference mark, so upon export only the first symbol will be written others will be discard.



47
48
49
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 47

def reference_mark
  @reference_mark
end

#text ⇒ Object

Gets or sets text of the footnote. This method allows to quickly set text of a footnote from a string. The string can contain paragraph breaks, this will create paragraphs of text in the footnote accordingly.



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

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'link' => :'Link',
    :'node_id' => :'NodeId',
    :'position' => :'Position',
    :'footnote_type' => :'FootnoteType',
    :'reference_mark' => :'ReferenceMark',
    :'text' => :'Text',
    :'content' => :'Content'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 92

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'node_id' => :'String',
    :'position' => :'DocumentPosition',
    :'footnote_type' => :'String',
    :'reference_mark' => :'String',
    :'text' => :'String',
    :'content' => :'StoryChildNodes'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 167

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      node_id == other.node_id &&
      position == other.position &&
      footnote_type == other.footnote_type &&
      reference_mark == other.reference_mark &&
      text == other.text &&
      content == other.content
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



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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 216

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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 287

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 194

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 



301
302
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 301

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 187

def hash
  [link, node_id, position, footnote_type, reference_mark, text, content].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



267
268
269
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 267

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



273
274
275
276
277
278
279
280
281
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 273

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



261
262
263
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 261

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



143
144
145
146
147
148
 
# File 'lib/aspose_words_cloud/models/footnote.rb', line 143

def valid?
  footnote_type_validator = EnumAttributeValidator.new('String', ["Footnote", "Endnote"])
  return false unless footnote_type_validator.valid?(@footnote_type)

  return true
end

#validate ⇒ Object 



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

def validate()
  unless self.link.nil?
      self.link.validate
  end
  unless self.position.nil?
      self.position.validate
  end
  unless self.content.nil?
      self.content.validate
  end

end