Class: Prawn::Document

Inherits:
Object
  • Object
show all
Includes:
Core::Annotations, Core::Destinations, GraphicsState, Internals, Security, Snapshot, Graphics, Images, Stamp, Text
Defined in:
lib/prawn/document.rb,
lib/prawn/font.rb,
lib/prawn/table.rb,
lib/prawn/outline.rb,
lib/prawn/repeater.rb,
lib/prawn/security.rb,
lib/prawn/table/cell.rb,
lib/prawn/document/snapshot.rb,
lib/prawn/document/internals.rb,
lib/prawn/document/bounding_box.rb,
lib/prawn/document/page_geometry.rb,
lib/prawn/document/graphics_state.rb

Overview

The Prawn::Document class is how you start creating a PDF document.

There are three basic ways you can instantiate PDF Documents in Prawn, they are through assignment, implicit block or explicit block. Below is an exmple of each type, each example does exactly the same thing, makes a PDF document with all the defaults and puts in the default font “Hello There” and then saves it to the current directory as “example.pdf”

For example, assignment can be like this:

pdf = Prawn::Document.new
pdf.text "Hello There"
pdf.render_file "example.pdf"

Or you can do an implied block form:

Prawn::Document.generate "example.pdf" do
  text "Hello There"
end

Or if you need to access a variable outside the scope of the block, the explicit block form:

words = "Hello There"
Prawn::Document.generate "example.pdf" do |pdf|
  pdf.text words
end

Usually, the block forms are used when you are simply creating a PDF document that you want to immediately save or render out.

See the new and generate methods for further details on the above.

Defined Under Namespace

Modules: GraphicsState, Internals, PageGeometry, Security, Snapshot Classes: BoundingBox

Constant Summary

Constants included from Graphics

Graphics::KAPPA

Constants included from Graphics::JoinStyle

Graphics::JoinStyle::JOIN_STYLES

Constants included from Graphics::CapStyle

Graphics::CapStyle::CAP_STYLES

Constants included from Text

Text::NBSP

Constants included from Core::Text

Core::Text::VALID_OPTIONS

Constants included from Snapshot

Snapshot::RollbackTransaction

Constants included from Core::Destinations

Core::Destinations::NAME_TREE_CHILDREN_LIMIT

Instance Attribute Summary collapse

Attributes included from Core::Text

#skip_encoding

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Stamp

#create_stamp, #stamp, #stamp_at

Methods included from Images

#image

Methods included from Graphics

#circle_at, #curve, #curve_to, #ellipse_at, #fill, #fill_and_stroke, #horizontal_line, #horizontal_rule, #line, #line_to, #line_width, #line_width=, #move_to, #polygon, #rectangle, #rounded_polygon, #rounded_rectangle, #rounded_vertex, #stroke, #stroke_bounds, #vertical_line

Methods included from Graphics::Transformation

#rotate, #scale, #transformation_matrix, #translate

Methods included from Graphics::Transparency

#transparent

Methods included from Graphics::JoinStyle

#join_style

Methods included from Graphics::CapStyle

#cap_style

Methods included from Graphics::Dash

#dash, #dashed?, #undash

Methods included from Graphics::Color

#fill_color, hex2rgb, #method_missing, rgb2hex, #stroke_color

Methods included from Text

#draw_text, #formatted_text, #height_of, #height_of_formatted, #text, #text_box

Methods included from Text::Formatted

#formatted_text_box

Methods included from Core::Text

#character_spacing, #default_kerning, #default_kerning?, #default_leading, #default_leading?, #draw_text!, #process_text_options, #word_spacing

Methods included from Security

#encrypt_document, encrypt_string

Methods included from Core

EncryptedPdfObject, PdfObject, Reference

Methods included from GraphicsState

#restore_graphics_state, #save_graphics_state

Methods included from Snapshot

#rollback, #transaction

Methods included from Core::Destinations

#add_dest, #dest_fit, #dest_fit_bounds, #dest_fit_bounds_horizontally, #dest_fit_bounds_vertically, #dest_fit_horizontally, #dest_fit_rect, #dest_fit_vertically, #dest_xyz, #dests

Methods included from Core::Annotations

#annotate, #link_annotation, #text_annotation

Methods included from Internals

#add_content, #before_render, #deref, #names, #names?, #on_page_create, #ref, #ref!

Constructor Details

#initialize(options = {}, &block) ⇒ Document

Creates a new PDF Document. The following options are available (with the default values marked in [])

:page_size

One of the Document::PageGeometry sizes [LETTER]

:page_layout

Either :portrait or :landscape

:margin

Sets the margin on all sides in points [0.5 inch]

:left_margin

Sets the left margin in points [0.5 inch]

:right_margin

Sets the right margin in points [0.5 inch]

:top_margin

Sets the top margin in points [0.5 inch]

:bottom_margin

Sets the bottom margin in points [0.5 inch]

:skip_page_creation

Creates a document without starting the first page [false]

:compress

Compresses content streams before rendering them [false]

:optimize_objects

Reduce number of PDF objects in output, at expense of render time [false]

:background

An image path to be used as background on all pages [nil]

:info

Generic hash allowing for custom metadata properties [nil]

:template

The path to an existing PDF file to use as a template [nil]

Setting e.g. the :margin to 100 points and the :left_margin to 50 will result in margins of 100 points on every side except for the left, where it will be 50.

The :margin can also be an array much like CSS shorthand:

# Top and bottom are 20, left and right are 100.
:margin => [20, 100]
# Top is 50, left and right are 100, bottom is 20.
:margin => [50, 100, 20]
# Top is 10, right is 20, bottom is 30, left is 40.
:margin => [10, 20, 30, 40]

Additionally, :page_size can be specified as a simple two value array giving the width and height of the document you need in PDF Points.

Usage:

# New document, US Letter paper, portrait orientation
pdf = Prawn::Document.new

# New document, A4 paper, landscaped
pdf = Prawn::Document.new(:page_size => "A4", :page_layout => :landscape)

# New document, Custom size
pdf = Prawn::Document.new(:page_size => [200, 300])

# New document, with background
pdf = Prawn::Document.new(:background => "#{Prawn::BASEDIR}/data/images/pigs.jpg")

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/prawn/document.rb', line 169

def initialize(options={},&block)   
  Prawn.verify_options [:page_size, :page_layout, :margin, :left_margin, 
    :right_margin, :top_margin, :bottom_margin, :skip_page_creation, 
    :compress, :skip_encoding, :background, :info,
    :optimize_objects, :template], options

  # need to fix, as the refactoring breaks this
  # raise NotImplementedError if options[:skip_page_creation]

  self.class.extensions.reverse_each { |e| extend e }
  @internal_state = Prawn::Core::DocumentState.new(options)
  @internal_state.populate_pages_from_store(self)
  min_version(state.store.min_version) if state.store.min_version

  @background = options[:background]
  @font_size  = 12

  @bounding_box  = nil
  @margin_box    = nil

  @page_number = 0

  options[:size] = options.delete(:page_size)
  options[:layout] = options.delete(:page_layout)

  if options[:template]
    fresh_content_streams(options)
    go_to_page(1)
  else
    if options[:skip_page_creation] || options[:template]
      start_new_page(options.merge(:orphan => true))
    else
      start_new_page(options)
    end
  end

  @bounding_box = @margin_box
  
  if block
    block.arity < 1 ? instance_eval(&block) : block[self]
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Prawn::Graphics::Color

Instance Attribute Details

#font_size(points = nil) ⇒ Object

When called with no argument, returns the current font size. When called with a single argument but no block, sets the current font size. When a block is used, the font size is applied transactionally and is rolled back when the block exits. You may still change the font size within a transactional block for individual text segments, or nested calls to font_size.

Prawn::Document.generate("font_size.pdf") do
  font_size 16
  text "At size 16"

  font_size(10) do
    text "At size 10"
    text "At size 6", :size => 6
    text "At size 10"
  end

  text "At size 16"
end

When called without an argument, this method returns the current font size.


92
93
94
95
96
97
98
# File 'lib/prawn/font.rb', line 92

def font_size(points=nil)
  return @font_size unless points
  size_before_yield = @font_size
  @font_size = points
  block_given? ? yield : return
  @font_size = size_before_yield
end

#margin_boxObject

Returns the value of attribute margin_box


212
213
214
# File 'lib/prawn/document.rb', line 212

def margin_box
  @margin_box
end

#marginsObject (readonly)

Returns the value of attribute margins


213
214
215
# File 'lib/prawn/document.rb', line 213

def margins
  @margins
end

#page_numberObject

Returns the value of attribute page_number


215
216
217
# File 'lib/prawn/document.rb', line 215

def page_number
  @page_number
end

#yObject

Returns the value of attribute y


213
214
215
# File 'lib/prawn/document.rb', line 213

def y
  @y
end

Class Method Details

.extensionsObject

Any module added to this array will be included into instances of Prawn::Document at the per-object level. These will also be inherited by any subclasses.

Example:

module MyFancyModule

  def party!
    text "It's a big party!"
  end

end

Prawn::Document.extensions << MyFancyModule

Prawn::Document.generate("foo.pdf") do
  party!
end

83
84
85
# File 'lib/prawn/document.rb', line 83

def self.extensions
  @extensions ||= []
end

.generate(filename, options = {}, &block) ⇒ Object

Creates and renders a PDF document.

When using the implicit block form, Prawn will evaluate the block within an instance of Prawn::Document, simplifying your syntax. However, please note that you will not be able to reference variables from the enclosing scope within this block.

# Using implicit block form and rendering to a file
Prawn::Document.generate "example.pdf" do
  # self here is set to the newly instantiated Prawn::Document
  # and so any variables in the outside scope are unavailable
  font "Times-Roman"
  draw_text "Hello World", :at => [200,720], :size => 32
end

If you need to access your local and instance variables, use the explicit block form shown below. In this case, Prawn yields an instance of PDF::Document and the block is an ordinary closure:

# Using explicit block form and rendering to a file
content = "Hello World"
Prawn::Document.generate "example.pdf" do |pdf|
  # self here is left alone
  pdf.font "Times-Roman"
  pdf.draw_text content, :at => [200,720], :size => 32
end

118
119
120
121
# File 'lib/prawn/document.rb', line 118

def self.generate(filename,options={},&block)
  pdf = new(options,&block)
  pdf.render_file(filename)
end

.inherited(base) ⇒ Object

:nodoc:


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

def self.inherited(base) #:nodoc:
  extensions.each { |e| base.extensions << e }
end

.move_past_bottomObject


478
479
480
# File 'lib/prawn/document.rb', line 478

def @bounding_box.move_past_bottom
  raise RollbackTransaction
end

Instance Method Details

#bounding_box(*args, &block) ⇒ Object

:call-seq:

bounding_box(point, options={}, &block)

A bounding box serves two important purposes:

  • Provide bounds for flowing text, starting at a given point

  • Translate the origin (0,0) for graphics primitives

A point and :width must be provided. :height is optional. (See stretchyness below)

Positioning

Bounding boxes are positioned relative to their top left corner and the width measurement is towards the right and height measurement is downwards.

Usage:

  • Bounding box 100pt x 100pt in the absolute bottom left of the containing box:

    pdf.bounding_box(, :width => 100, :height => 100)

    stroke_bounds
    

    end

  • Bounding box 200pt x 400pt high in the center of the page:

    x_pos = ((bounds.width / 2) - 150) y_pos = ((bounds.height / 2) + 200) pdf.bounding_box([x_pos, y_pos], :width => 300, :height => 400) do

    stroke_bounds
    

    end

Flowing Text

When flowing text, the usage of a bounding box is simple. Text will begin at the point specified, flowing the width of the bounding box. After the block exits, the cursor position will be moved to the bottom of the bounding box (y - height). If flowing text exceeds the height of the bounding box, the text will be continued on the next page, starting again at the top-left corner of the bounding box.

Usage:

pdf.bounding_box([100,500], :width => 100, :height => 300) do
  pdf.text "This text will flow in a very narrow box starting" +
   "from [100,500]. The pointer will then be moved to [100,200]" +
   "and return to the margin_box"
end

Note, this is a low level tool and is designed primarily for building other abstractions. If you just need to flow text on the page, you will want to look at text_box() instead

Translating Coordinates

When translating coordinates, the idea is to allow the user to draw relative to the origin, and then translate their drawing to a specified area of the document, rather than adjust all their drawing coordinates to match this new region.

Take for example two triangles which share one point, drawn from the origin:

pdf.polygon [0,250], [0,0], [150,100]
pdf.polygon [100,0], [150,100], [200,0]

It would be easy enough to translate these triangles to another point, e.g [200,200]

pdf.polygon [200,450], [200,200], [350,300]
pdf.polygon [300,200], [350,300], [400,200]

However, each time you want to move the drawing, you'd need to alter every point in the drawing calls, which as you might imagine, can become tedious.

If instead, we think of the drawing as being bounded by a box, we can see that the image is 200 points wide by 250 points tall.

To translate it to a new origin, we simply select a point at (x,y+height)

Using the [200,200] example:

pdf.bounding_box([200,450], :width => 200, :height => 250) do
  pdf.stroke do
    pdf.polygon [0,250], [0,0], [150,100]
    pdf.polygon [100,0], [150,100], [200,0]
  end
end

Notice that the drawing is still relative to the origin. If we want to move this drawing around the document, we simply need to recalculate the top-left corner of the rectangular bounding-box, and all of our graphics calls remain unmodified.

Nesting Bounding Boxes

At the top level, bounding boxes are specified relative to the document's margin_box (which is itself a bounding box). You can also nest bounding boxes, allowing you to build components which are relative to each other

Usage:

pdf.bounding_box([200,450], :width => 200, :height => 250) do
  pdf.stroke_bounds   # Show the containing bounding box 
  pdf.bounding_box([50,200], :width => 50, :height => 50) do
    # a 50x50 bounding box that starts 50 pixels left and 50 pixels down 
    # the parent bounding box.
    pdf.stroke_bounds
  end
end

Stretchyness

If you do not specify a height to a bounding box, it will become stretchy and its height will be calculated automatically as you stretch the box downwards.

pdf.bounding_box([100,400], :width => 400) do
  pdf.text("The height of this box is #{pdf.bounds.height}")
  pdf.text('this is some text')
  pdf.text('this is some more text')
  pdf.text('and finally a bit more')
  pdf.text("Now the height of this box is #{pdf.bounds.height}")
end

Absolute Positioning

If you wish to position the bounding boxes at absolute coordinates rather than relative to the margins or other bounding boxes, you can use canvas()

pdf.bounding_box([50,500], :width => 200, :height => 300) do
  pdf.stroke_bounds
  pdf.canvas do
    Positioned outside the containing box at the 'real' (300,450)
    pdf.bounding_box([300,450], :width => 200, :height => 200) do
      pdf.stroke_bounds
    end
  end
end

Of course, if you use canvas, you will be responsible for ensuring that you remain within the printable area of your document.


157
158
159
160
161
162
# File 'lib/prawn/document/bounding_box.rb', line 157

def bounding_box(*args, &block)    
  init_bounding_box(block) do |_|
    map_to_absolute!(args[0])     
    @bounding_box = BoundingBox.new(self, *args)   
  end
end

#boundsObject

The bounds method returns the current bounding box you are currently in, which is by default the box represented by the margin box on the document itself. When called from within a created bounding_box block, the box defined by that call will be returned instead of the document margin box.

Another important point about bounding boxes is that all x and y measurements within a bounding box code block are relative to the bottom left corner of the bounding box.

For example:

Prawn::Document.new do
  # In the default "margin box" of a Prawn document of 0.5in along each edge

  # Draw a border around the page (the manual way)
  stroke do
    line(bounds.bottom_left, bounds.bottom_right)
    line(bounds.bottom_right, bounds.top_right)
    line(bounds.top_right, bounds.top_left)
    line(bounds.top_left, bounds.bottom_left)
  end

  # Draw a border around the page (the easy way)
  stroke_bounds
end

373
374
375
# File 'lib/prawn/document.rb', line 373

def bounds
  @bounding_box
end

#bounds=(bounding_box) ⇒ Object

Sets Document#bounds to the BoundingBox provided. See above for a brief description of what a bounding box is. This function is useful if you really need to change the bounding box manually, but usually, just entering and exiting bounding box code blocks is good enough.


382
383
384
# File 'lib/prawn/document.rb', line 382

def bounds=(bounding_box)
  @bounding_box = bounding_box
end

#canvas(&block) ⇒ Object

A shortcut to produce a bounding box which is mapped to the document's absolute coordinates, regardless of how things are nested or margin sizes.

pdf.canvas do
  pdf.line pdf.bounds.bottom_left, pdf.bounds.top_right
end

171
172
173
174
175
176
177
178
# File 'lib/prawn/document/bounding_box.rb', line 171

def canvas(&block)     
  init_bounding_box(block, :hold_position => true) do |_|
    @bounding_box = BoundingBox.new(self, [0,page.dimensions[3]], 
      :width => page.dimensions[2], 
      :height => page.dimensions[3] 
    ) 
  end
end

#cell(options = {}) ⇒ Object

Instantiates and draws a cell on the document.

cell(:content => "Hello world!", :at => [12, 34])

See Prawn::Table::Cell.make for full options.


18
19
20
21
22
# File 'lib/prawn/table/cell.rb', line 18

def cell(options={})
  cell = Table::Cell.make(self, options.delete(:content), options)
  cell.draw
  cell
end

#compression_enabled?Boolean

Returns true if content streams will be compressed before rendering, false otherwise

Returns:

  • (Boolean)

520
521
522
# File 'lib/prawn/document.rb', line 520

def compression_enabled?
  !!state.compress
end

#cursorObject

The current y drawing position relative to the innermost bounding box, or to the page margins at the top level.


297
298
299
# File 'lib/prawn/document.rb', line 297

def cursor
  y - bounds.absolute_bottom
end

#define_outline(&block) ⇒ Object

See Outline#define below for documentation


14
15
16
# File 'lib/prawn/outline.rb', line 14

def define_outline(&block)
  outline.define(&block)
end

#find_font(name, options = {}) ⇒ Object

Looks up the given font using the given criteria. Once a font has been found by that matches the criteria, it will be cached to subsequent lookups for that font will return the same object. – Challenges involved: the name alone is not sufficient to uniquely identify a font (think dfont suitcases that can hold multiple different fonts in a single file). Thus, the :name key is included in the cache key.

It is further complicated, however, since fonts in some formats (like the dfont suitcases) can be identified either by numeric index, OR by their name within the suitcase, and both should hash to the same font object (to avoid the font being embedded multiple times). This is not yet implemented, which means if someone selects a font both by name, and by index, the font will be embedded twice. Since we do font subsetting, this double embedding won't be catastrophic, just annoying. ++


137
138
139
140
141
142
143
144
145
146
147
# File 'lib/prawn/font.rb', line 137

def find_font(name, options={}) #:nodoc: 
  if font_families.key?(name) 
    family, name = name, font_families[name][options[:style] || :normal] 
    if name.is_a?(Hash) 
      options = options.merge(name) 
      name = options[:file] 
    end 
  end 
  key = "#{name}:#{options[:font] || 0}" 
  font_registry[key] ||= Font.load(self, name, options.merge(:family => family)) 
end

#floatObject

Executes a block and then restores the original y position

pdf.text "A"

pdf.float do
  pdf.move_down 100
  pdf.text "C"
end

pdf.text "B"

318
319
320
# File 'lib/prawn/document.rb', line 318

def float 
  mask(:y) { yield }
end

#font(name = nil, options = {}) ⇒ Object

Without arguments, this returns the currently selected font. Otherwise, it sets the current font. When a block is used, the font is applied transactionally and is rolled back when the block exits.

Prawn::Document.generate("font.pdf") do
  text "Default font is Helvetica"

  font "Times-Roman"
  text "Now using Times-Roman"

  font("Chalkboard.ttf") do
    text "Using TTF font from file Chalkboard.ttf"
    font "Courier", :style => :bold
    text "You see this in bold Courier"
  end

  text "Times-Roman, again"
end

The :name parameter must be a string. It can be one of the 14 built-in fonts supported by PDF, or the location of a TTF file. The Font::AFM::BUILT_INS array specifies the valid built in font values.

If a ttf font is specified, the glyphs necessary to render your document will be embedded in the rendered PDF. This should be your preferred option in most cases. It will increase the size of the resulting file, but also make it more portable.

The options parameter is an optional hash providing size and style. To use the :style option you need to map those font styles to their respective font files. See font_families for more information.


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/prawn/font.rb', line 48

def font(name=nil, options={})
  return((defined?(@font) && @font) || font("Helvetica")) if name.nil?

  if state.pages.empty? && !state.page.in_stamp_stream?
    raise Prawn::Errors::NotOnPage 
  end
  
  new_font = find_font(name, options)

  if block_given?
    save_font do
      set_font(new_font, options[:size])
      yield
    end
  else
    set_font(new_font, options[:size])
  end

  @font
end

#font_familiesObject

Hash that maps font family names to their styled individual font names.

To add support for another font family, append to this hash, e.g:

pdf.font_families.update(
 "MyTrueTypeFamily" => { :bold        => "foo-bold.ttf",
                         :italic      => "foo-italic.ttf",
                         :bold_italic => "foo-bold-italic.ttf",
                         :normal      => "foo.ttf" })

This will then allow you to use the fonts like so:

pdf.font("MyTrueTypeFamily", :style => :bold)
pdf.text "Some bold text"
pdf.font("MyTrueTypeFamily")
pdf.text "Some normal text"

This assumes that you have appropriate TTF fonts for each style you wish to support.

By default the styles :bold, :italic, :bold_italic, and :normal are defined for fonts “Courier”, “Times-Roman” and “Helvetica”.

You probably want to provide those four styles, but are free to define custom ones, like :thin, and use them in font calls.


181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/prawn/font.rb', line 181

def font_families
  @font_families ||= Hash.new { |h,k| h[k] = {} }.merge!(
    { "Courier"     => { :bold        => "Courier-Bold",
                         :italic      => "Courier-Oblique",
                         :bold_italic => "Courier-BoldOblique",
                         :normal      => "Courier" },

      "Times-Roman" => { :bold         => "Times-Bold",
                         :italic       => "Times-Italic",
                         :bold_italic  => "Times-BoldItalic",
                         :normal       => "Times-Roman" },

      "Helvetica"   => { :bold         => "Helvetica-Bold",
                         :italic       => "Helvetica-Oblique",
                         :bold_italic  => "Helvetica-BoldOblique",
                         :normal       => "Helvetica" }
    })
end

#font_registryObject

Hash of Font objects keyed by names


151
152
153
# File 'lib/prawn/font.rb', line 151

def font_registry #:nodoc:
  @font_registry ||= {}
end

#go_to_page(k) ⇒ Object

Re-opens the page with the given (1-based) page number so that you can draw on it.

See Prawn::Document#number_pages for a sample usage of this capability.


282
283
284
285
286
287
# File 'lib/prawn/document.rb', line 282

def go_to_page(k)
  @page_number = k
  state.page = state.pages[k-1]
  generate_margin_box
  @y = @bounding_box.absolute_top
end

#group(second_attempt = false) ⇒ Object

Attempts to group the given block vertically within the current context. First attempts to render it in the current position on the current page. If that attempt overflows, it is tried anew after starting a new context (page or column).

Raises CannotGroup if the provided content is too large to fit alone in the current page or column.


474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/prawn/document.rb', line 474

def group(second_attempt=false)
  old_bounding_box = @bounding_box
  @bounding_box = SimpleDelegator.new(@bounding_box)

  def @bounding_box.move_past_bottom
    raise RollbackTransaction
  end

  success = transaction { yield }

  unless success
    raise Prawn::Errors::CannotGroup if second_attempt
    old_bounding_box.move_past_bottom
    group(second_attempt=true) { yield }
  end 

  @bounding_box = old_bounding_box
end

#indent(x, &block) ⇒ Object

Indents the specified number of PDF points for the duration of the block

pdf.text "some text"
pdf.indent(20) do
  pdf.text "This is indented 20 points"
end
pdf.text "This starts 20 points left of the above line " +
         "and is flush with the first line"

451
452
453
# File 'lib/prawn/document.rb', line 451

def indent(x, &block)
  bounds.indent(x, &block)
end

#make_table(data, options = {}, &block) ⇒ Object

Set up, but do not draw, a table. Useful for creating subtables to be inserted into another Table. Call draw on the resulting Table to ink it.

See the documentation on Prawn::Table for details on the arguments.


35
36
37
# File 'lib/prawn/table.rb', line 35

def make_table(data, options={}, &block)
  Table.new(data, self, options, &block)
end

#mask(*fields) ⇒ Object

:nodoc:


456
457
458
459
460
461
462
463
464
# File 'lib/prawn/document.rb', line 456

def mask(*fields) # :nodoc:
 # Stores the current state of the named attributes, executes the block, and
 # then restores the original values after the block has executed.
 # -- I will remove the nodoc if/when this feature is a little less hacky
  stored = {}
  fields.each { |f| stored[f] = send(f) }
  yield
  fields.each { |f| send("#{f}=", stored[f]) }
end

#move_cursor_to(new_y) ⇒ Object

Moves to the specified y position in relative terms to the bottom margin.


303
304
305
# File 'lib/prawn/document.rb', line 303

def move_cursor_to(new_y)
  self.y = new_y + bounds.absolute_bottom
end

#move_down(n) ⇒ Object

Moves down the document by n points relative to the current position inside the current bounding box.


396
397
398
# File 'lib/prawn/document.rb', line 396

def move_down(n)
  self.y -= n
end

#move_up(n) ⇒ Object

Moves up the document by n points relative to the current position inside the current bounding box.


389
390
391
# File 'lib/prawn/document.rb', line 389

def move_up(n)
  self.y += n
end

#number_pages(string, position) ⇒ Object

Specify a template for page numbering. This should be called towards the end of document creation, after all your content is already in place. In your template string, <page> refers to the current page, and <total> refers to the total amount of pages in the doucment.

Example:

Prawn::Document.generate("page_with_numbering.pdf") do
  text "Hai"
  start_new_page
  text "bai"
  start_new_page
  text "-- Hai again"
  number_pages "<page> in a total of <total>", [bounds.right - 50, 0]  
end

509
510
511
512
513
514
515
# File 'lib/prawn/document.rb', line 509

def number_pages(string, position)
  page_count.times do |i|
    go_to_page(i+1)
    str = string.gsub("<page>","#{i+1}").gsub("<total>","#{page_count}")
    draw_text str, :at => position
  end
end

#outlineObject

Lazily instantiates an Outline object for document. This is used as point of entry to methods to build the outline tree.


27
28
29
# File 'lib/prawn/outline.rb', line 27

def outline
  @outline ||= Outline.new(self)
end

#outline_root(outline_root) ⇒ Object

The Outline dictionary (12.3.3) for this document. It is lazily initialized, so that documents that do not have an outline do not incur the additional overhead.


21
22
23
# File 'lib/prawn/outline.rb', line 21

def outline_root(outline_root)
  state.store.root.data[:Outlines] ||= ref!(outline_root)
end

#pad(y) ⇒ Object

Moves down the document by y, executes a block, then moves down the document by y again.

pdf.text "some text"
pdf.pad(100) do
  pdf.text "This is 100 points below the previous line of text"
end
pdf.text "This is 100 points below the previous line of text"

435
436
437
438
439
# File 'lib/prawn/document.rb', line 435

def pad(y)
  move_down(y)
  yield
  move_down(y)
end

#pad_bottom(y) ⇒ Object

Executes a block then moves down the document

pdf.text "some text"
pdf.pad_bottom(100) do
  pdf.text "This text appears right below the previous line of text"
end
pdf.text "This is 100 points below the previous line of text"

421
422
423
424
# File 'lib/prawn/document.rb', line 421

def pad_bottom(y)
  yield
  move_down(y)
end

#pad_top(y) ⇒ Object

Moves down the document and then executes a block.

pdf.text "some text"
pdf.pad_top(100) do
  pdf.text "This is 100 points below the previous line of text"
end
pdf.text "This text appears right below the previous line of text"

408
409
410
411
# File 'lib/prawn/document.rb', line 408

def pad_top(y)
  move_down(y)
  yield
end

#pageObject


221
222
223
# File 'lib/prawn/document.rb', line 221

def page
  state.page
end

#page_countObject

Returns the number of pages in the document

pdf = Prawn::Document.new
pdf.page_count #=> 1
3.times { pdf.start_new_page }
pdf.page_count #=> 4

273
274
275
# File 'lib/prawn/document.rb', line 273

def page_count
  state.page_count
end

#renderObject

Renders the PDF document to string


324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/prawn/document.rb', line 324

def render
  output = StringIO.new
  finalize_all_page_contents

  render_header(output)
  render_body(output)
  render_xref(output)
  render_trailer(output)
  str = output.string
  str.force_encoding("ASCII-8BIT") if str.respond_to?(:force_encoding)
  str
end

#render_file(filename) ⇒ Object

Renders the PDF document to file.

pdf.render_file "foo.pdf"

341
342
343
344
# File 'lib/prawn/document.rb', line 341

def render_file(filename)
  Kernel.const_defined?("Encoding") ? mode = "wb:ASCII-8BIT" : mode = "wb"
  File.open(filename,mode) { |f| f << render }
end

#repeat(page_filter, options = {}, &block) ⇒ Object

Provides a way to execute a block of code repeatedly based on a page_filter. Since Stamp is used under the hood, this method is very space efficient.

Available page filters are:

:all        -- repeats on every page
:odd        -- repeats on odd pages
:even       -- repeats on even pages
some_array  -- repeats on every page listed in the array
some_range  -- repeats on every page included in the range
some_lambda -- yields page number and repeats for true return values

Also accepts an optional second argument for dynamic content which executes the code in the context of the filtered pages without using a Stamp.

Example:

Prawn::Document.generate("repeat.pdf", :skip_page_creation => true) do

  repeat :all do
    draw_text "ALLLLLL", :at => bounds.top_left
  end

  repeat :odd do
    draw_text "ODD", :at => [0,0]
  end

  repeat :even do
    draw_text "EVEN", :at => [0,0]
  end

  repeat [1,2] do 
    draw_text "[1,2]", :at => [100,0]
  end

  repeat 2..4 do
    draw_text "2..4", :at => [200,0]
  end

  repeat(lambda { |pg| pg % 3 == 0 }) do
    draw_text "Every third", :at => [250, 20]
  end

  10.times do 
    start_new_page
    draw_text "A wonderful page", :at => [400,400]
  end

  repeat(:all, :dynamic => true) do
    text page_number, :at => [500, 0]
  end

end

76
77
78
# File 'lib/prawn/repeater.rb', line 76

def repeat(page_filter, options={}, &block)
  repeaters << Prawn::Repeater.new(self, page_filter, !!options[:dynamic], &block)
end

#repeatersObject

A list of all repeaters in the document. See Document#repeat for details


18
19
20
# File 'lib/prawn/repeater.rb', line 18

def repeaters
  @repeaters ||= []
end

#save_fontObject

Saves the current font, and then yields. When the block finishes, the original font is restored.


111
112
113
114
115
116
117
118
119
# File 'lib/prawn/font.rb', line 111

def save_font
  @font ||= find_font("Helvetica")
  original_font = @font
  original_size = @font_size

  yield
ensure
  set_font(original_font, original_size) if original_font
end

#set_font(font, size = nil) ⇒ Object

Sets the font directly, given an actual Font object and size.


103
104
105
106
# File 'lib/prawn/font.rb', line 103

def set_font(font, size=nil) # :nodoc:
  @font = font
  @font_size = size if size
end

#start_new_page(options = {}) ⇒ Object

Creates and advances to a new page in the document.

Page size, margins, and layout can also be set when generating a new page. These values will become the new defaults for page creation

pdf.start_new_page #=> Starts new page keeping current values
pdf.start_new_page(:size => "LEGAL", :layout => :landscape)
pdf.start_new_page(:left_margin => 50, :right_margin => 50)
pdf.start_new_page(:margin => 100)

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/prawn/document.rb', line 235

def start_new_page(options = {})
   if last_page = state.page
     last_page_size    = last_page.size
     last_page_layout  = last_page.layout
     last_page_margins = last_page.margins
   end

   state.page = Prawn::Core::Page.new(self, 
     :size    => options[:size]   || last_page_size, 
     :layout  => options[:layout] || last_page_layout,
     :margins => last_page_margins )

   apply_margin_options(options)

   use_graphic_settings
  
   unless options[:orphan]
     state.insert_page(state.page, @page_number)
     @page_number += 1

     save_graphics_state
    
     canvas { image(@background, :at => bounds.top_left) } if @background 
     @y = @bounding_box.absolute_top

     float do
       state.on_page_create_action(self)
     end
   end
end

#stateObject


217
218
219
# File 'lib/prawn/document.rb', line 217

def state
  @internal_state
end

#table(data, options = {}, &block) ⇒ Object

Set up and draw a table on this document. A block can be given, which will be run after cell setup but before layout and drawing.

See the documentation on Prawn::Table for details on the arguments.


24
25
26
27
28
# File 'lib/prawn/table.rb', line 24

def table(data, options={}, &block)
  t = Table.new(data, self, options, &block)
  t.draw
  t
end

#width_of(string, options = {}) ⇒ Object

Returns the width of the given string using the given font. If :size is not specified as one of the options, the string is measured using the current font size. You can also pass :kerning as an option to indicate whether kerning should be used when measuring the width (defaults to false).

Note that the string must be encoded properly for the font being used. For AFM fonts, this is WinAnsi. For TTF, make sure the font is encoded as UTF-8. You can use the Font#normalize_encoding method to make sure strings are in an encoding appropriate for the current font. – For the record, this method used to be a method of Font (and still delegates to width computations on Font). However, having the primary interface for calculating string widths exist on Font made it tricky to write extensions for Prawn in which widths are computed differently (e.g., taking formatting tags into account, or the like).

By putting width_of here, on Document itself, extensions may easily override it and redefine the width calculation behavior. ++


219
220
221
# File 'lib/prawn/font.rb', line 219

def width_of(string, options={})
  font.compute_width_of(string, options) + character_spacing * string.length
end