Class: Origami::Annotation

Inherits:
Dictionary show all
Includes:
StandardObject
Defined in:
lib/origami/annotations.rb,
lib/origami/3d.rb

Overview

Class representing an annotation. Annotations are objects which user can interact with.

Defined Under Namespace

Modules: Flags, Markup, Triggerable Classes: AdditionalActions, AppearanceCharacteristics, AppearanceDictionary, AppearanceStream, Artwork3D, BorderStyle, Circle, FileAttachment, FreeText, Link, RichMedia, Screen, Shape, Sound, Square, Text, Widget

Constant Summary

Constants included from StandardObject

StandardObject::DEFAULT_ATTRIBUTES

Constants inherited from Dictionary

Dictionary::TOKENS

Constants included from Object

Object::TOKENS

Instance Attribute Summary

Attributes inherited from Dictionary

#names_cache, #strings_cache, #xref_cache

Attributes included from Object

#file_offset, #generation, #no, #objstm_offset, #parent

Instance Method Summary collapse

Methods included from StandardObject

#do_type_check, #has_field?, included, #pdf_version_required, #pre_build, #set_default_value, #set_default_values

Methods inherited from Dictionary

#[], #[]=, add_type_info, #cast_to, #copy, #delete, guess_type, #has_key?, hint_type, #initialize, #map!, #merge, #method_missing, native_type, parse, #to_obfuscated_str, #to_s

Methods included from Object

#<=>, #cast_to, #copy, #export, #indirect_parent, #initialize, #is_indirect?, #logicalize, #logicalize!, native_type, #native_type, parse, #pdf, #pdf_version_required, #post_build, #pre_build, #reference, #resolve_all_references, #set_indirect, #set_pdf, #size, skip_until_next_obj, #solve, #to_o, #to_s, #type, typeof, #xrefs

Methods inherited from Hash

#to_o

Constructor Details

This class inherits a constructor from Origami::Dictionary

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Origami::Dictionary

Instance Method Details

#set_down_appearance(apstm) ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/origami/annotations.rb', line 65

def set_down_appearance(apstm)
  self.AP ||= AppearanceStream.new
  self.AP[:D] = apstm

  self
end

#set_normal_appearance(apstm) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/origami/annotations.rb', line 51

def set_normal_appearance(apstm)
  self.AP ||= AppearanceDictionary.new
  self.AP[:N] = apstm

  self
end

#set_rollover_appearance(apstm) ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/origami/annotations.rb', line 58

def set_rollover_appearance(apstm)
  self.AP ||= AppearanceDictionary.new
  self.AP[:R] = apstm

  self
end