Class: Pdfrb::Model::Type::StructureElementKid

Inherits:
Cos::Dictionary show all
Defined in:
lib/pdfrb/model/type/structure_element_kid.rb

Overview

Structure Element Kid Reference. When a struct element's kid is a content-stream marker (MCID), the kid is represented as an integer; when it's a sub-element, it's a dict reference.

Instance Attribute Summary

Attributes inherited from Object

#document, #gen, #oid, #value

Instance Method Summary collapse

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

#content_item? ⇒ Boolean

Returns:

  • (Boolean) 


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

def content_item?
  !mcid.nil?
end

#mcid ⇒ Object 



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

def mcid; self[:MCID]; end

#object ⇒ Object 



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

def object; self[:Obj]; end

#object_reference? ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/pdfrb/model/type/structure_element_kid.rb', line 20

def object_reference?
  !!object
end

#page ⇒ Object 



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

def page; self[:Pg]; end

#resolved_page ⇒ Object 



24
25
26
27
28
29
 
# File 'lib/pdfrb/model/type/structure_element_kid.rb', line 24

def resolved_page
  ref = page
  return nil unless ref && document

  document.object(ref)
end

#structure_type ⇒ Object 



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

def structure_type; self[:S]; end

#type ⇒ Object 



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

def type; self[:Type]; end