Class: Pdfrb::Model::Type::FileAttachmentAnnotation

Inherits:
MarkupAnnotation show all
Defined in:
lib/pdfrb/model/type/file_attachment_annotation.rb

Overview

File-attachment annotation (s12.5.6.15). Embedded file displayed as a paper-clip icon.

Instance Attribute Summary

Attributes inherited from Object

#document, #gen, #oid, #value

Instance Method Summary collapse

Methods inherited from MarkupAnnotation

#creation_date, #external_data, #group_reply?, #in_reply_to, #intent, #interior_color, #opacity, #open?, #popup, #reply?, #reply_type, #rich_contents, #subject, #title

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, #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

#embedded_file ⇒ Object 



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

def embedded_file; self[:FS]; end

#has_attachment? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/pdfrb/model/type/file_attachment_annotation.rb', line 16

def has_attachment?
  !!embedded_file
end

#icon_name ⇒ Object 



12
13
14
 
# File 'lib/pdfrb/model/type/file_attachment_annotation.rb', line 12

def icon_name
  (name || :PushPin).to_sym
end

#name ⇒ Object 



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

def name; self[:Name]; end

#resolved_file_spec ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/pdfrb/model/type/file_attachment_annotation.rb', line 20

def resolved_file_spec
  ref = embedded_file
  return nil unless ref && document

  document.object(ref)
end