Parent

Included Modules

Prawn::Document

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.

Attributes

margin_box[RW]
page[RW]
margins[R]
y[R]
store[R]
pages[R]
font_size[W]
default_line_wrap[RW]

Public Class Methods

extensions() click to toggle source

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
    # File lib/prawn/document.rb, line 94
94:     def self.extensions
95:       @extensions ||= []
96:     end
generate(filename,options={},&block) click to toggle source

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
     # File lib/prawn/document.rb, line 129
129:     def self.generate(filename,options={},&block)
130:       pdf = new(options,&block)
131:       pdf.render_file(filename)
132:     end
new(options={},&block) click to toggle source

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]

:text_options

A set of default options to be handed to text(). Be careful with this.

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")
     # File lib/prawn/document.rb, line 180
180:     def initialize(options={},&block)   
181:        Prawn.verify_options [:page_size, :page_layout, :margin, :left_margin, 
182:          :right_margin, :top_margin, :bottom_margin, :skip_page_creation, 
183:          :compress, :skip_encoding, :text_options, :background, :info,
184:          :optimize_objects], options
185: 
186: 
187:        # need to fix, as the refactoring breaks this
188:        # raise NotImplementedError if options[:skip_page_creation]
189: 
190:        self.class.extensions.reverse_each { |e| extend e }
191:       
192:        options[:info] ||= {}
193:        options[:info][:Creator] ||= "Prawn"
194:        options[:info][:Producer] = "Prawn"
195: 
196:        options[:info].keys.each do |key|
197:          if options[:info][key].kind_of?(String)
198:            options[:info][key] = Prawn::LiteralString.new(options[:info][key])
199:          end
200:        end
201:           
202:        @version = 1.3
203:        @store = Prawn::Core::ObjectStore.new(options[:info])
204:        @trailer = {}
205: 
206:        @before_render_callbacks = []
207:        @on_page_create_callback = nil
208: 
209:        @compress         = options[:compress] || false
210:        @optimize_objects = options.fetch(:optimize_objects, false)
211:        @skip_encoding    = options[:skip_encoding]
212:        @background       = options[:background]
213:        @font_size        = 12
214: 
215:        @pages            = []
216:        @page             = nil
217: 
218:        @bounding_box  = nil
219:        @margin_box    = nil
220: 
221:        @text_options = options[:text_options] || {}
222:        @default_line_wrap = Prawn::Text::LineWrap.new
223: 
224:        @page_number = 0
225: 
226:        options[:size] = options.delete(:page_size)
227:        options[:layout] = options.delete(:page_layout)
228: 
229:        if options[:skip_page_creation]
230:          start_new_page(options.merge(:orphan => true))
231:        else
232:          start_new_page(options)
233:        end
234:        
235:        @bounding_box = @margin_box
236:        
237:        if block
238:          block.arity < 1 ? instance_eval(&block) : block[self]
239:        end
240:      end

Public Instance Methods

bounding_box(point, options={}, &block) click to toggle source

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([0,100], :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 span() and 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.

     # File lib/prawn/document/bounding_box.rb, line 157
157:     def bounding_box(*args, &block)    
158:       init_bounding_box(block) do |_|
159:         map_to_absolute!(args[0])     
160:         @bounding_box = BoundingBox.new(self, *args)   
161:       end
162:     end
bounds() click to toggle source

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
     # File lib/prawn/document.rb, line 409
409:     def bounds
410:       @bounding_box
411:     end
bounds=(bounding_box) click to toggle source

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.

     # File lib/prawn/document.rb, line 418
418:     def bounds=(bounding_box)
419:       @bounding_box = bounding_box
420:     end
canvas(&block) click to toggle source

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
     # File lib/prawn/document/bounding_box.rb, line 171
171:     def canvas(&block)     
172:       init_bounding_box(block, :hold_position => true) do |_|
173:         @bounding_box = BoundingBox.new(self, [0,page.dimensions[3]], 
174:           :width => page.dimensions[2], 
175:           :height => page.dimensions[3] 
176:         ) 
177:       end
178:     end
column_box(*args, &block) click to toggle source

A column box is a bounding box with the additional property that when text flows past the bottom, it will wrap first to another column on the same page, and only flow to the next page when all the columns are filled.

column_box accepts the same parameters as bounding_box, as well as the number of :columns and a :spacer (in points) between columns.

Defaults are :columns = 3 and :spacer = font_size

Under PDF::Writer, “spacer” was known as “gutter“

    # File lib/prawn/document/column_box.rb, line 24
24:     def column_box(*args, &block)
25:       init_column_box(block) do |_|
26:         map_to_absolute!(args[0])
27:         @bounding_box = ColumnBox.new(self, *args)
28:       end
29:     end
compression_enabled?() click to toggle source

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

     # File lib/prawn/document.rb, line 556
556:     def compression_enabled?
557:       !!@compress
558:     end
cursor() click to toggle source

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

     # File lib/prawn/document.rb, line 332
332:     def cursor
333:       y - bounds.absolute_bottom
334:     end
define_outline(&block) click to toggle source

See Outline#define below for documentation

    # File lib/prawn/outline.rb, line 14
14:     def define_outline(&block)
15:       outline.define(&block)
16:     end
float() click to toggle source

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" 
  
     # File lib/prawn/document.rb, line 354
354:     def float 
355:       mask(:y) { yield }
356:     end
font(name=nil, options={}) click to toggle source

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.

    # File lib/prawn/font.rb, line 48
48:     def font(name=nil, options={})
49:       return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
50: 
51:       raise Errors::NotOnPage if pages.empty? && !page.in_stamp_stream?
52:       new_font = find_font(name, options)
53: 
54:       if block_given?
55:         save_font do
56:           set_font(new_font, options[:size])
57:           yield
58:         end
59:       else
60:         set_font(new_font, options[:size])
61:       end
62: 
63:       @font
64:     end
font_families() click to toggle source

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.

     # File lib/prawn/font.rb, line 178
178:     def font_families
179:       @font_families ||= Hash.new { |h,k| h[k] = {} }.merge!(
180:         { "Courier"     => { :bold        => "Courier-Bold",
181:                              :italic      => "Courier-Oblique",
182:                              :bold_italic => "Courier-BoldOblique",
183:                              :normal      => "Courier" },
184: 
185:           "Times-Roman" => { :bold         => "Times-Bold",
186:                              :italic       => "Times-Italic",
187:                              :bold_italic  => "Times-BoldItalic",
188:                              :normal       => "Times-Roman" },
189: 
190:           "Helvetica"   => { :bold         => "Helvetica-Bold",
191:                              :italic       => "Helvetica-Oblique",
192:                              :bold_italic  => "Helvetica-BoldOblique",
193:                              :normal       => "Helvetica" }
194:         })
195:     end
font_size(points=nil) click to toggle source

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.

    # File lib/prawn/font.rb, line 89
89:     def font_size(points=nil)
90:       return @font_size unless points
91:       size_before_yield = @font_size
92:       @font_size = points
93:       block_given? ? yield : return
94:       @font_size = size_before_yield
95:     end
go_to_page(k) click to toggle source

Re-opens the page with the given (1-based) page number so that you can draw on it. Does not restore page state such as margins, page orientation, or paper size, so you’ll have to handle that yourself.

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

     # File lib/prawn/document.rb, line 319
319:     def go_to_page(k)
320:       @page_number = k
321:       self.page = pages[k-1]
322:     end
group(second_attempt=false) click to toggle source

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.

     # File lib/prawn/document.rb, line 510
510:     def group(second_attempt=false)
511:       old_bounding_box = @bounding_box
512:       @bounding_box = SimpleDelegator.new(@bounding_box)
513: 
514:       def @bounding_box.move_past_bottom
515:         raise RollbackTransaction
516:       end
517: 
518:       success = transaction { yield }
519: 
520:       unless success
521:         raise Prawn::Errors::CannotGroup if second_attempt
522:         old_bounding_box.move_past_bottom
523:         group(second_attempt=true) { yield }
524:       end 
525: 
526:       @bounding_box = old_bounding_box
527:     end
indent(x, &block) click to toggle source

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"
     # File lib/prawn/document.rb, line 487
487:     def indent(x, &block)
488:       bounds.indent(x, &block)
489:     end
move_cursor_to(new_y) click to toggle source

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

     # File lib/prawn/document.rb, line 339
339:     def move_cursor_to(new_y)
340:       self.y = new_y + bounds.absolute_bottom
341:     end
move_down(n) click to toggle source

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

     # File lib/prawn/document.rb, line 432
432:     def move_down(n)
433:       self.y -= n
434:     end
move_up(n) click to toggle source

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

     # File lib/prawn/document.rb, line 425
425:     def move_up(n)
426:       self.y += n
427:     end
number_pages(string, position) click to toggle source

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, refers to the current page, and 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
     # File lib/prawn/document.rb, line 545
545:     def number_pages(string, position)
546:       page_count.times do |i|
547:         go_to_page(i+1)
548:         str = string.gsub("<page>","#{i+1}").gsub("<total>","#{page_count}")
549:         draw_text str, :at => position
550:       end
551:     end
outline() click to toggle source

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

    # File lib/prawn/outline.rb, line 27
27:     def outline
28:       @outline ||= Outline.new(self)
29:     end
outline_root(outline_root) click to toggle source

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.

    # File lib/prawn/outline.rb, line 21
21:     def outline_root(outline_root)
22:       @store.root.data[:Outlines] ||= ref!(outline_root)
23:     end
pad(y) click to toggle source

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"
     # File lib/prawn/document.rb, line 471
471:     def pad(y)
472:       move_down(y)
473:       yield
474:       move_down(y)
475:     end
pad_bottom(y) click to toggle source

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"
     # File lib/prawn/document.rb, line 457
457:     def pad_bottom(y)
458:       yield
459:       move_down(y)
460:     end
pad_top(y) click to toggle source

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"
     # File lib/prawn/document.rb, line 444
444:     def pad_top(y)
445:       move_down(y)
446:       yield
447:     end
page_count() click to toggle source

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
     # File lib/prawn/document.rb, line 302
302:     def page_count
303:       pages.length
304:     end
page_number() click to toggle source

Returns the 1-based page number of the current page. Returns 0 if the document has no pages.

     # File lib/prawn/document.rb, line 309
309:     def page_number
310:       @page_number
311:     end
render() click to toggle source

Renders the PDF document to string

     # File lib/prawn/document.rb, line 360
360:     def render
361:       output = StringIO.new
362:       finalize_all_page_contents
363: 
364:       render_header(output)
365:       render_body(output)
366:       render_xref(output)
367:       render_trailer(output)
368:       str = output.string
369:       str.force_encoding("ASCII-8BIT") if str.respond_to?(:force_encoding)
370:       str
371:     end
render_file(filename) click to toggle source

Renders the PDF document to file.

  pdf.render_file "foo.pdf"
     # File lib/prawn/document.rb, line 377
377:     def render_file(filename)
378:       Kernel.const_defined?("Encoding") ? mode = "wb:ASCII-8BIT" : mode = "wb"
379:       File.open(filename,mode) { |f| f << render }
380:     end
repeat(page_filter, options={}, &block) click to toggle source

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
    # File lib/prawn/repeater.rb, line 76
76:     def repeat(page_filter, options={}, &block)
77:       repeaters << Prawn::Repeater.new(self, page_filter, !!options[:dynamic], &block)
78:     end
repeaters() click to toggle source

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

    # File lib/prawn/repeater.rb, line 18
18:     def repeaters
19:       @repeaters ||= []
20:     end
save_font() click to toggle source

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

     # File lib/prawn/font.rb, line 108
108:     def save_font
109:       @font ||= find_font("Helvetica")
110:       original_font = @font
111:       original_size = @font_size
112: 
113:       yield
114:     ensure
115:       set_font(original_font, original_size) if original_font
116:     end
span(width, options={}) click to toggle source

A span is a special purpose bounding box that allows a column of elements to be positioned relative to the margin_box.

Arguments:

width

The width of the column in PDF points

Options:

:position

One of :left, :center, :right or an x offset

This method is typically used for flowing a column of text from one page to the next.

 span(350, :position => :center) do
   text "Here's some centered text in a 350 point column. " * 100
 end
 
    # File lib/prawn/document/span.rb, line 27
27:     def span(width, options={})
28:       Prawn.verify_options [:position], options
29:       original_position = self.y      
30:      
31:       # FIXME: Any way to move this upstream?
32:       left_boundary = case(options[:position] || :left)
33:       when :left
34:         margin_box.absolute_left
35:       when :center
36:         margin_box.absolute_left + margin_box.width / 2.0 - width /2.0
37:       when :right
38:         margin_box.absolute_right - width
39:       when Numeric
40:         margin_box.absolute_left + options[:position]
41:       else
42:         raise ArgumentError, "Invalid option for :position"
43:       end
44:       
45:       # we need to bust out of whatever nested bounding boxes we're in.
46:       canvas do
47:         bounding_box([left_boundary, 
48:                       margin_box.absolute_top], :width => width) do
49:           self.y = original_position
50:           yield
51:         end
52:       end          
53:     end
54:   end
55: end
56: 
start_new_page(options = {}) click to toggle source

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)
     # File lib/prawn/document.rb, line 252
252:      def start_new_page(options = {})
253:        if last_page = page
254:          last_page_size    = last_page.size
255:          last_page_layout  = last_page.layout
256:          last_page_margins = last_page.margins
257:        end
258: 
259:        self.page = Prawn::Core::Page.new(self, 
260:          :size    => options[:size]   || last_page_size, 
261:          :layout  => options[:layout] || last_page_layout,
262:          :margins => last_page_margins )
263:   
264:        
265:        apply_margin_option(options) if options[:margin]
266: 
267:        [:left,:right,:top,:bottom].each do |side|
268:          if margin = options[:"#{side}_margin"]
269:            page.margins[side] = margin
270:          end
271:        end
272: 
273:        generate_margin_box
274: 
275:        update_colors
276:        undash if dashed?
277:       
278:        unless options[:orphan]
279:          pages.insert(@page_number, page)
280:          @store.pages.data[:Kids].insert(@page_number, page.dictionary)
281:          @store.pages.data[:Count] += 1
282:          @page_number += 1
283: 
284:          save_graphics_state
285:         
286:          canvas { image(@background, :at => bounds.top_left) } if @background 
287:          @y = @bounding_box.absolute_top
288: 
289:          float do
290:            @on_page_create_callback.call(self) if @on_page_create_callback 
291:          end
292:        end
293:     end
width_of(string, options={}) click to toggle source

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.

     # File lib/prawn/font.rb, line 216
216:     def width_of(string, options={})
217:       font.compute_width_of(string, options)
218:     end
y=(new_y) click to toggle source
     # File lib/prawn/document.rb, line 324
324:     def y=(new_y)
325:       @y = new_y
326:       bounds.update_height
327:     end

Private Instance Methods

apply_margin_option(options) click to toggle source
     # File lib/prawn/document.rb, line 578
578:     def apply_margin_option(options)
579:       # Treat :margin as CSS shorthand with 1-4 values.
580:       margin = Array(options[:margin])
581:       positions = { 4 => [0,1,2,3], 3 => [0,1,2,1],
582:                     2 => [0,1,0,1], 1 => [0,0,0,0] }[margin.length]
583: 
584:       [:top, :right, :bottom, :left].zip(positions).each do |p,i|
585:         options[:"#{p}_margin"] ||= margin[i]
586:       end
587:     end
generate_margin_box() click to toggle source
     # File lib/prawn/document.rb, line 562
562:     def generate_margin_box
563:       old_margin_box = @margin_box
564:       @margin_box = BoundingBox.new(
565:         self,
566:         [ page.margins[:left], page.dimensions[1] - page.margins[:top] ] ,
567:         :width => page.dimensions[2] - (page.margins[:left] + page.margins[:right]),
568:         :height => page.dimensions[1] - (page.margins[:top] + page.margins[:bottom])
569:       )
570: 
571:       # we must update bounding box if not flowing from the previous page
572:       #
573:       # FIXME: This may have a bug where the old margin is restored
574:       # when the bounding box exits.
575:       @bounding_box = @margin_box if old_margin_box == @bounding_box
576:     end
init_bounding_box(user_block, options={}, &init_block) click to toggle source
     # File lib/prawn/document/bounding_box.rb, line 182
182:     def init_bounding_box(user_block, options={}, &init_block)
183:       parent_box = @bounding_box       
184: 
185:       init_block.call(parent_box)     
186: 
187:       self.y = @bounding_box.absolute_top       
188:       user_block.call   
189:       self.y = @bounding_box.absolute_bottom unless options[:hold_position]
190: 
191:       created_box, @bounding_box = @bounding_box, parent_box
192: 
193:       return created_box
194:     end
init_column_box(user_block, options={}, &init_block) click to toggle source
    # File lib/prawn/document/column_box.rb, line 33
33:     def init_column_box(user_block, options={}, &init_block)
34:       parent_box = @bounding_box
35: 
36:       init_block.call(parent_box)
37: 
38:       self.y = @bounding_box.absolute_top
39:       user_block.call
40:       self.y = @bounding_box.absolute_bottom unless options[:hold_position]
41: 
42:       @bounding_box = parent_box
43:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.