Class | Prawn::Outline
In: | lib/prawn/outline.rb
Parent: | Object

The Outline class organizes the outline tree items for the document. Note that the prev and parent instance variables are adjusted while navigating through the nested blocks. These variables along with the presence or absense of blocks are the primary means by which the relations for the various OutlineItems and the OutlineRoot are set. Unfortunately, the best way to understand how this works is to follow the method calls through a real example.

Some ideas for the organization of this class were gleaned from name_tree. In particular the way in which the OutlineItems are finally rendered into document objects in PdfObject through a hash.

### Methods

add_section define insert_section_after new

### Attributes

document | [RW] |
items | [RW] |
outline_root | [RW] |
parent | [RW] |
prev | [RW] |

### Public Class methods

new(document)

### Public Instance methods

add_section(&block)

Adds an outine section to the outline tree (see define_outline). Although you will probably choose to exclusively use define_outline so that your outline tree is contained and easy to manage, this method gives you the option to add sections to the outline tree at any point during document generation. Note that the section will be added at the top level at the end of the outline. For more a more flexible API try using outline.insert_section_after.

block uses the same DSL syntax as define_outline, for example:

      outline.add_section do
        section 'Added Section', :page => 3 do
          page 3, :title => 'Page 3'
        end
      end

define(&block)

Defines an outline for the document. The outline is an optional nested index that appears on the side of a PDF document usually with direct links to pages. The outline DSL is defined by nested blocks involving two methods: section and page.

section(title, options{}, &block)

      title: the outline text that appears for the section.
      options: page - optional integer defining the page number for a destination link.
                    - currently only :FIT destination supported with link to top of page.
               closed - whether the section should show its nested outline elements.
                      - defaults to false.

page(page, options{})

      page: integer defining the page number for the destination link.
            currently only :FIT destination supported with link to top of page.
            set to nil if destination link is not desired.
      options: title - the outline text that appears for the section.
               closed - whether the section should show its nested outline elements.
                      - defaults to false.

The syntax is best illustrated with an example:

Prawn::Document.generate(outlined document) do

      text "Page 1. This is the first Chapter. "
      start_new_page
      text "Page 2. More in the first Chapter. "
      start_new_page
      define_outline do
        section 'Chapter 1', :page => 1, :closed => true do
          page 1, :title => 'Page 1'
          page 2, :title => 'Page 2'
        end
      end

end

It should be noted that not defining a title for a page element will raise a RequiredOption error

insert_section_after(title, &block)

Inserts an outline section to the outline tree (see define_outline). Although you will probably choose to exclusively use define_outline so that your outline tree is contained and easy to manage, this method gives you the option to insert sections to the outline tree at any point during document generation. Unlike outline.add_section, this method allows you to enter a section after any other item at any level in the outline tree. Currently the only way to locate the place of entry is with the title for the item. If your titles names are not unique consider using define_outline.

block uses the same DSL syntax as define_outline, for example:

      go_to_page 2
      start_new_page
      text "Inserted Page"
      outline.insert_section_after :title => 'Page 2' do
        page page_number, :title => "Inserted Page"
      end

[Validate]