class AsposePdfCloud::Bookmark

Provides link to bookmark.

Attributes

action[RW]

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".

bold[RW]

Is bookmark bold.

bookmarks[RW]

The children bookmarks.

color[RW]

Get the color

destination[RW]

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

italic[RW]

Is bookmark italic.

level[RW]

Gets or sets bookmark's hierarchy level.

page_display[RW]

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

page_display_bottom[RW]

Gets or sets the bottom coordinate of page display.

page_display_left[RW]

Gets or sets the left coordinate of page display.

page_display_right[RW]

Gets or sets the right coordinate of page display.

page_display_top[RW]

Gets or sets the top coordinate of page display.

page_display_zoom[RW]

Gets or sets the zoom factor of page display.

page_number[RW]

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

remote_file[RW]

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

title[RW]

Get the Title;

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose_pdf_cloud/models/bookmark.rb, line 245
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/aspose_pdf_cloud/models/bookmark.rb, line 208
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_pdf_cloud/models/bookmark.rb, line 325
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_pdf_cloud/models/bookmark.rb, line 319
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_pdf_cloud/models/bookmark.rb, line 215
def valid?
  return true
end