Class: Pdfrb::Model::Type::Destination

Inherits:
PdfArray show all
Defined in:
lib/pdfrb/model/type/destination.rb

Overview

Explicit destination array [page, display_type, *params] (s12.3.2.2). Element 0 is a page reference (or integer page number); element 1 names the display mode.

Instance Attribute Summary

Attributes inherited from Object

#document, #gen, #oid, #value

Instance Method Summary collapse

Methods inherited from PdfArray

#<<, #==, #[], #[]=, apply_arlington_definition, arlington_definition, #delete_at, #each, element_field, #empty?, #initialize, #inspect, #length, #push, #to_a

Methods included from Cos::ArlingtonBacked

#arlington_object

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::PdfArray

Instance Method Details

#display_typeObject



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

def display_type; self[1]; end

#fit?Boolean

Returns:

  • (Boolean)


23
# File 'lib/pdfrb/model/type/destination.rb', line 23

def fit?; display_type == :Fit; end

#fit_b?Boolean

Returns:

  • (Boolean)


27
# File 'lib/pdfrb/model/type/destination.rb', line 27

def fit_b?; display_type == :FitB; end

#fit_bh?Boolean

Returns:

  • (Boolean)


28
# File 'lib/pdfrb/model/type/destination.rb', line 28

def fit_bh?; display_type == :FitBH; end

#fit_bv?Boolean

Returns:

  • (Boolean)


29
# File 'lib/pdfrb/model/type/destination.rb', line 29

def fit_bv?; display_type == :FitBV; end

#fit_h?Boolean

Returns:

  • (Boolean)


24
# File 'lib/pdfrb/model/type/destination.rb', line 24

def fit_h?; display_type == :FitH; end

#fit_r?Boolean

Returns:

  • (Boolean)


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

def fit_r?; display_type == :FitR; end

#fit_v?Boolean

Returns:

  • (Boolean)


25
# File 'lib/pdfrb/model/type/destination.rb', line 25

def fit_v?; display_type == :FitV; end

#page_numberObject



18
19
20
# File 'lib/pdfrb/model/type/destination.rb', line 18

def page_number
  page_ref if page_number?
end

#page_number?Boolean

True when element 0 is an integer page number (GoTo D form).

Returns:

  • (Boolean)


14
15
16
# File 'lib/pdfrb/model/type/destination.rb', line 14

def page_number?
  page_ref.is_a?(Integer)
end

#page_refObject



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

def page_ref; self[0]; end

#xyz?Boolean

Returns:

  • (Boolean)


22
# File 'lib/pdfrb/model/type/destination.rb', line 22

def xyz?; display_type == :XYZ; end