Class: Pdfrb::Model::Type::MarkupAnnotation

Inherits:

Annotation

• Object
• Object
• Cos::Dictionary
• Annotation
• Pdfrb::Model::Type::MarkupAnnotation

Defined in:

lib/pdfrb/model/type/markup_annotation.rb

Direct Known Subclasses

CaretAnnotation, CircleAnnotation, FileAttachmentAnnotation, FreeTextAnnotation, InkAnnotation, LineAnnotation, PolygonAnnotation, PolylineAnnotation, RedactAnnotation, SoundAnnotation, SquareAnnotation, StampAnnotation, TextAnnotation, TextMarkupAnnotation

Instance Attribute Summary

Attributes inherited from Object

#document, #gen, #oid, #value

Instance Method Summary

• #creation_date ⇒ Object
• #external_data ⇒ Object
• #group_reply? ⇒ Boolean
• #in_reply_to ⇒ Object
• #intent ⇒ Object
• #interior_color ⇒ Object
• #opacity ⇒ Object
• #open? ⇒ Boolean
• #popup ⇒ Object
• #reply? ⇒ Boolean
• #reply_type ⇒ Object
• #rich_contents ⇒ Object
• #subject ⇒ Object
• #title ⇒ Object

Methods inherited from Annotation

#action, #additional_actions, #appearance, #appearance_state, #border, #color, #contents, #create_appearance_stream, #flags, for_subtype, #hidden?, #locked?, #locked_contents?, #modified_date, #name, #no_rotate?, #no_view?, #no_zoom?, #normal_appearance, #page, #print?, #read_only?, #rect, register_subtype, #subtype, subtype_map, #toggle_no_view?

Methods inherited from Cos::Dictionary

#[], #[]=, arlington_available?, arlington_default, arlington_key_to_symbol, arlington_loaded_for?, arlington_mark_loaded, arlington_object, arlington_one_type_to_ruby, arlington_required?, arlington_types_to_ruby, arlington_version, define_field, define_field_from_arlington, #delete, #each, each_field, #each_raw, #empty?, field, #initialize, #key?, #keys, lookup_type, own_fields, #pdf_type, register_type, type_map, #validate

Methods inherited from Object

#==, define_type, #deref, #indirect?, #initialize, #must_be_indirect?, #pdf_type, pdf_type

Constructor Details

This class inherits a constructor from Pdfrb::Model::Cos::Dictionary

Instance Method Details

#creation_date ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 10

def creation_date; self[:CreationDate]; end

#external_data ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 15

def external_data; self[:ExData]; end

#group_reply? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 30

def group_reply?
  reply_type&.to_sym == :Group
end

#in_reply_to ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 13

def in_reply_to; self[:IRT]; end

#intent ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 12

def intent; self[:IT]; end

#interior_color ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 17

def interior_color; self[:IC]; end

#opacity ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 16

def opacity; self[:CA]; end

#open? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 19

def open?
  return false unless popup

  obj = popup.is_a?(Pdfrb::Model::Reference) && document ? document.object(popup) : popup
  obj && obj[:Open]
end

#popup ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 8

def popup; self[:Popup]; end

#reply? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 26

def reply?
  !!in_reply_to
end

#reply_type ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 14

def reply_type; self[:RT]; end

#rich_contents ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 9

def rich_contents; self[:RC]; end

#subject ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 11

def subject; self[:Subj]; end

#title ⇒ Object

# File 'lib/pdfrb/model/type/markup_annotation.rb', line 7

def title; self[:T]; end