Class: AsposePdfCloud::Bookmark

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/bookmark.rb

Overview

Provides link to bookmark.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Bookmark

Initializes the object

Parameters:

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

    Model attributes in the form of hash



128
129
130
131
132
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 128

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.has_key?(:'Links')
    if (value = attributes[:'Links']).is_a?(Array)
      self.links = value
    end
  end

  if attributes.has_key?(:'Title')
    self.title = attributes[:'Title']
  end

  if attributes.has_key?(:'Italic')
    self.italic = attributes[:'Italic']
  end

  if attributes.has_key?(:'Bold')
    self.bold = attributes[:'Bold']
  end

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

  if attributes.has_key?(:'Action')
    self.action = attributes[:'Action']
  end

  if attributes.has_key?(:'Level')
    self.level = attributes[:'Level']
  end

  if attributes.has_key?(:'Destination')
    self.destination = attributes[:'Destination']
  end

  if attributes.has_key?(:'PageDisplay')
    self.page_display = attributes[:'PageDisplay']
  end

  if attributes.has_key?(:'PageDisplay_Bottom')
    self.page_display_bottom = attributes[:'PageDisplay_Bottom']
  end

  if attributes.has_key?(:'PageDisplay_Left')
    self.page_display_left = attributes[:'PageDisplay_Left']
  end

  if attributes.has_key?(:'PageDisplay_Right')
    self.page_display_right = attributes[:'PageDisplay_Right']
  end

  if attributes.has_key?(:'PageDisplay_Top')
    self.page_display_top = attributes[:'PageDisplay_Top']
  end

  if attributes.has_key?(:'PageDisplay_Zoom')
    self.page_display_zoom = attributes[:'PageDisplay_Zoom']
  end

  if attributes.has_key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end

  if attributes.has_key?(:'RemoteFile')
    self.remote_file = attributes[:'RemoteFile']
  end

  if attributes.has_key?(:'Bookmarks')
    self.bookmarks = attributes[:'Bookmarks']
  end

end

Instance Attribute Details

#action ⇒ Object

Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named".



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 44

def action
  @action
end

#bold ⇒ Object

Is bookmark bold.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 38

def bold
  @bold
end

#bookmarks ⇒ Object

The children bookmarks.



77
78
79
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 77

def bookmarks
  @bookmarks
end

#color ⇒ Object

Get the color



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 41

def color
  @color
end

#destination ⇒ Object

Gets or sets bookmark’s destination page. Required if action is set as string.Empty.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 50

def destination
  @destination
end

#italic ⇒ Object

Is bookmark italic.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 35

def italic
  @italic
end

#level ⇒ Object

Gets or sets bookmark’s hierarchy level.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 47

def level
  @level
end

#links ⇒ Object

Link to the document.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 29

def links
  @links
end

#page_display ⇒ Object

Gets or sets the type of display bookmark’s destination page.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 53

def page_display
  @page_display
end

#page_display_bottom ⇒ Object

Gets or sets the bottom coordinate of page display.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 56

def page_display_bottom
  @page_display_bottom
end

#page_display_left ⇒ Object

Gets or sets the left coordinate of page display.



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 59

def page_display_left
  @page_display_left
end

#page_display_right ⇒ Object

Gets or sets the right coordinate of page display.



62
63
64
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 62

def page_display_right
  @page_display_right
end

#page_display_top ⇒ Object

Gets or sets the top coordinate of page display.



65
66
67
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 65

def page_display_top
  @page_display_top
end

#page_display_zoom ⇒ Object

Gets or sets the zoom factor of page display.



68
69
70
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 68

def page_display_zoom
  @page_display_zoom
end

#page_number ⇒ Object

Gets or sets the number of bookmark’s destination page.



71
72
73
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 71

def page_number
  @page_number
end

#remote_file ⇒ Object

Gets or sets the file (path) which is required for "GoToR" action of bookmark.



74
75
76
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 74

def remote_file
  @remote_file
end

#title ⇒ Object

Get the Title;



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 32

def title
  @title
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
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 81

def self.attribute_map
  {
    :'links' => :'Links',
    :'title' => :'Title',
    :'italic' => :'Italic',
    :'bold' => :'Bold',
    :'color' => :'Color',
    :'action' => :'Action',
    :'level' => :'Level',
    :'destination' => :'Destination',
    :'page_display' => :'PageDisplay',
    :'page_display_bottom' => :'PageDisplay_Bottom',
    :'page_display_left' => :'PageDisplay_Left',
    :'page_display_right' => :'PageDisplay_Right',
    :'page_display_top' => :'PageDisplay_Top',
    :'page_display_zoom' => :'PageDisplay_Zoom',
    :'page_number' => :'PageNumber',
    :'remote_file' => :'RemoteFile',
    :'bookmarks' => :'Bookmarks'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 104

def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'title' => :'String',
    :'italic' => :'BOOLEAN',
    :'bold' => :'BOOLEAN',
    :'color' => :'Color',
    :'action' => :'String',
    :'level' => :'Integer',
    :'destination' => :'String',
    :'page_display' => :'String',
    :'page_display_bottom' => :'Integer',
    :'page_display_left' => :'Integer',
    :'page_display_right' => :'Integer',
    :'page_display_top' => :'Integer',
    :'page_display_zoom' => :'Integer',
    :'page_number' => :'Integer',
    :'remote_file' => :'String',
    :'bookmarks' => :'Bookmarks'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      title == o.title &&
      italic == o.italic &&
      bold == o.bold &&
      color == o.color &&
      action == o.action &&
      level == o.level &&
      destination == o.destination &&
      page_display == o.page_display &&
      page_display_bottom == o.page_display_bottom &&
      page_display_left == o.page_display_left &&
      page_display_right == o.page_display_right &&
      page_display_top == o.page_display_top &&
      page_display_zoom == o.page_display_zoom &&
      page_number == o.page_number &&
      remote_file == o.remote_file &&
      bookmarks == o.bookmarks
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 279

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  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 = AsposePdfCloud.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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 345

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 258

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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 251

def hash
  [links, title, italic, bold, color, action, level, destination, page_display, page_display_bottom, page_display_left, page_display_right, page_display_top, page_display_zoom, page_number, remote_file, bookmarks].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



208
209
210
211
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 208

def list_invalid_properties
  invalid_properties = Array.new
  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



325
326
327
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 325

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 331

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



319
320
321
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 319

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



215
216
217
 
# File 'lib/aspose_pdf_cloud/models/bookmark.rb', line 215

def valid?
  return true
end