Module: Prawn::Document::Destinations

Included in:
Prawn::Document
Defined in:
lib/prawn/document/destinations.rb

Constant Summary collapse

NAME_TREE_CHILDREN_LIMIT =

The maximum number of children to fit into a single node in the Dests tree.

20

Instance Method Summary collapse

Instance Method Details

#add_dest(name, reference) ⇒ Object

Adds a new destination to the dests name tree (see #dests). The reference parameter will be converted into a Prawn::Reference if it is not already one.


30
31
32
33
# File 'lib/prawn/document/destinations.rb', line 30

def add_dest(name, reference)
  reference = ref!(reference) unless reference.is_a?(Prawn::Reference)
  dests.data.add(name, reference)
end

#dest_fit(page = current_page) ⇒ Object

Return a Dest specification that will fit the given page into the viewport.


45
46
47
# File 'lib/prawn/document/destinations.rb', line 45

def dest_fit(page=current_page)
  [page, :Fit]
end

#dest_fit_bounds(page = current_page) ⇒ Object

Return a Dest specfication that will fit the given page's bounding box into the viewport.


73
74
75
# File 'lib/prawn/document/destinations.rb', line 73

def dest_fit_bounds(page=current_page)
  [page, :FitB]
end

#dest_fit_bounds_horizontally(top, page = current_page) ⇒ Object

Same as #dest_fit_horizontally, but works on the page's bounding box instead of the entire page.


80
81
82
# File 'lib/prawn/document/destinations.rb', line 80

def dest_fit_bounds_horizontally(top, page=current_page)
  [page, :FitBH, top]
end

#dest_fit_bounds_vertically(left, page = current_page) ⇒ Object

Same as #dest_fit_vertically, but works on the page's bounding box instead of the entire page.


87
88
89
# File 'lib/prawn/document/destinations.rb', line 87

def dest_fit_bounds_vertically(left, page=current_page)
  [page, :FitBV, left]
end

#dest_fit_horizontally(top, page = current_page) ⇒ Object

Return a Dest specification that will fit the given page horizontally into the viewport, aligned vertically at the given top coordinate.


52
53
54
# File 'lib/prawn/document/destinations.rb', line 52

def dest_fit_horizontally(top, page=current_page)
  [page, :FitH, top]
end

#dest_fit_rect(left, bottom, right, top, page = current_page) ⇒ Object

Return a Dest specification that will fit the given rectangle into the viewport, for the given page.


66
67
68
# File 'lib/prawn/document/destinations.rb', line 66

def dest_fit_rect(left, bottom, right, top, page=current_page)
  [page, :FitR, left, bottom, right, top]
end

#dest_fit_vertically(left, page = current_page) ⇒ Object

Return a Dest specification that will fit the given page vertically into the viewport, aligned horizontally at the given left coordinate.


59
60
61
# File 'lib/prawn/document/destinations.rb', line 59

def dest_fit_vertically(left, page=current_page)
  [page, :FitV, left]
end

#dest_xyz(left, top, zoom = nil, page = current_page) ⇒ Object

Return a Dest specification for a specific location (and optional zoom level).


38
39
40
# File 'lib/prawn/document/destinations.rb', line 38

def dest_xyz(left, top, zoom=nil, page=current_page)
  [page, :XYZ, left, top, zoom]
end

#destsObject

The Dests name tree in the Name dictionary (see Prawn::Document::Internal#names). This name tree is used to store named destinations (PDF spec 8.2.1). (For more on name trees, see section 3.8.4 in the PDF spec.)


22
23
24
# File 'lib/prawn/document/destinations.rb', line 22

def dests
  names.data[:Dests] ||= ref!(Prawn::NameTree::Node.new(self, NAME_TREE_CHILDREN_LIMIT))
end