# encoding: utf-8
#
# table.rb: Table drawing functionality.
#
# Copyright December 2009, Brad Ediger. All rights reserved.
#
# This is free software. Please see the LICENSE and COPYING files for details.
require 'prawn/table/cells'
require 'prawn/table/cell'
require 'prawn/table/cell/in_table'
require 'prawn/table/cell/text'
require 'prawn/table/cell/subtable'
require 'prawn/table/cell/image'
require 'prawn/table/cell/span_dummy'
module Prawn
class Document
# 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.
#
def table(data, options={}, &block)
t = Table.new(data, self, options, &block)
t.draw
t
end
# 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.
#
def make_table(data, options={}, &block)
Table.new(data, self, options, &block)
end
end
# Next-generation table drawing for Prawn.
#
# = Data
#
# Data, for a Prawn table, is a two-dimensional array of objects that can be
# converted to cells ("cellable" objects). Cellable objects can be:
#
# String::
# Produces a text cell. This is the most common usage.
# Prawn::Table::Cell::
# If you have already built a Cell or have a custom subclass of Cell you
# want to use in a table, you can pass through Cell objects.
# Prawn::Table::
# Creates a subtable (a table within a cell). You can use
# Prawn::Document#make_table to create a table for use as a subtable
# without immediately drawing it. See examples/table/bill.rb for a
# somewhat complex use of subtables.
# Array::
# Creates a simple subtable. Create a Table object using make_table (see
# above) if you need more control over the subtable's styling.
#
# = Options
#
# Prawn/Layout provides many options to control style and layout of your
# table. These options are implemented with a uniform interface: the +:foo+
# option always sets the +foo=+ accessor. See the accessor and method
# documentation for full details on the options you can pass. Some
# highlights:
#
# +cell_style+::
# A hash of style options to style all cells. See the documentation on
# Prawn::Table::Cell for all cell style options.
# +header+::
# If set to +true+, the first row will be repeated on every page. The
# header must be included as the first row of your data. Row numbering
# (for styling and other row-specific options) always indexes based on
# your data array. Whether or not you have a header, row(n) always refers
# to the nth element (starting from 0) of the +data+ array.
# +column_widths+::
# Sets widths for individual columns. Manually setting widths can give
# better results than letting Prawn guess at them, as Prawn's algorithm
# for defaulting widths is currently pretty boneheaded. If you experience
# problems like weird column widths or CannotFit errors, try manually
# setting widths on more columns.
# +position+::
# Either :left (the default), :center, :right, or a number. Specifies the
# horizontal position of the table within its bounding box. If a number is
# provided, it specifies the distance in points from the left edge.
#
# = Initializer Block
#
# If a block is passed to methods that initialize a table
# (Prawn::Table.new, Prawn::Document#table, Prawn::Document#make_table), it
# will be called after cell setup but before layout. This is a very flexible
# way to specify styling and layout constraints. This code sets up a table
# where the second through the fourth rows (1-3, indexed from 0) are each one
# inch (72 pt) wide:
#
# pdf.table(data) do |table|
# table.rows(1..3).width = 72
# end
#
# As with Prawn::Document#initialize, if the block has no arguments, it will
# be evaluated in the context of the object itself. The above code could be
# rewritten as:
#
# pdf.table(data) do
# rows(1..3).width = 72
# end
#
class Table
# Set up a table on the given document. Arguments:
#
# +data+::
# A two-dimensional array of cell-like objects. See the "Data" section
# above for the types of objects that can be put in a table.
# +document+::
# The Prawn::Document instance on which to draw the table.
# +options+::
# A hash of attributes and values for the table. See the "Options" block
# above for details on available options.
#
def initialize(data, document, options={}, &block)
@pdf = document
@cells = make_cells(data)
@header = false
@epsilon = 1e-9
options.each { |k, v| send("#{k}=", v) }
if block
block.arity < 1 ? instance_eval(&block) : block[self]
end
set_column_widths
set_row_heights
position_cells
end
# Number of rows in the table.
#
attr_reader :row_length
# Number of columns in the table.
#
attr_reader :column_length
# Manually set the width of the table.
#
attr_writer :width
# Position (:left, :right, :center, or a number indicating distance in
# points from the left edge) of the table within its parent bounds.
#
attr_writer :position
# Returns a Prawn::Table::Cells object representing all of the cells in
# this table.
#
attr_reader :cells
# Specify a callback to be called before each page of cells is rendered.
# The block is passed a Cells object containing all cells to be rendered on
# that page. You can change styling of the cells in this block, but keep in
# mind that the cells have already been positioned and sized.
#
def before_rendering_page(&block)
@before_rendering_page = block
end
# Returns the width of the table in PDF points.
#
def width
@width ||= [natural_width, @pdf.bounds.width].min
end
# Sets column widths for the table. The argument can be one of the following
# types:
#
# +Array+::
# <tt>[w0, w1, w2, ...]</tt> (specify a width for each column)
# +Hash+::
# <tt>{0 => w0, 1 => w1, ...}</tt> (keys are column names, values are
# widths)
# +Numeric+::
# +72+ (sets width for all columns)
#
def column_widths=(widths)
case widths
when Array
widths.each_with_index { |w, i| column(i).width = w }
when Hash
widths.each { |i, w| column(i).width = w }
when Numeric
cells.width = widths
else
raise ArgumentError, "cannot interpret column widths"
end
end
# Returns the height of the table in PDF points.
#
def height
cells.height
end
# If +true+, designates the first row as a header row to be repeated on
# every page. Does not change row numbering -- row numbers always index into
# the data array provided, with no modification.
#
attr_writer :header
# Accepts an Array of alternating row colors to stripe the table.
#
attr_writer :row_colors
# Sets styles for all cells.
#
# pdf.table(data, :cell_style => { :borders => [:left, :right] })
#
def cell_style=(style_hash)
cells.style(style_hash)
end
# Allows generic stylable content. This is an alternate syntax that some
# prefer to the attribute-based syntax. This code using style:
#
# pdf.table(data) do
# style(row(0), :background_color => 'ff00ff')
# style(column(0)) { |c| c.border_width += 1 }
# end
#
# is equivalent to:
#
# pdf.table(data) do
# row(0).style :background_color => 'ff00ff'
# column(0).style { |c| c.border_width += 1 }
# end
#
def style(stylable, style_hash={}, &block)
stylable.style(style_hash, &block)
end
# Draws the table onto the document at the document's current y-position.
#
def draw
with_position do
# The cell y-positions are based on an infinitely long canvas. The offset
# keeps track of how much we have to add to the original, theoretical
# y-position to get to the actual position on the current page.
offset = @pdf.y
# Reference bounds are the non-stretchy bounds used to decide when to
# flow to a new column / page.
ref_bounds = @pdf.reference_bounds
last_y = @pdf.y
# Determine whether we're at the top of the current bounds (margin box or
# bounding box). If we're at the top, we couldn't gain any more room by
# breaking to the next page -- this means, in particular, that if the
# first row is taller than the margin box, we will only move to the next
# page if we're below the top. Some floating-point tolerance is added to
# the calculation.
#
# Note that we use the actual bounds, not the reference bounds. This is
# because even if we are in a stretchy bounding box, flowing to the next
# page will not buy us any space if we are at the top.
if @pdf.y > @pdf.bounds.height + @pdf.bounds.absolute_bottom - 0.001
# we're at the top of our bounds
started_new_page_at_row = 0
else
started_new_page_at_row = -1
# If there isn't enough room left on the page to fit the first data row
# (excluding the header), start the table on the next page.
needed_height = row(0).height
needed_height += row(1).height if @header
if needed_height > @pdf.y - ref_bounds.absolute_bottom
@pdf.bounds.move_past_bottom
offset = @pdf.y
started_new_page_at_row = 0
end
end
# Duplicate each cell of the header row into @header_row so it can be
# modified in before_rendering_page callbacks.
if @header
@header_row = Cells.new
row(0).each { |cell| @header_row[cell.row, cell.column] = cell.dup }
end
# Track cells to be drawn on this page. They will all be drawn when this
# page is finished.
cells_this_page = []
@cells.each do |cell|
if cell.height > (cell.y + offset) - ref_bounds.absolute_bottom &&
cell.row > started_new_page_at_row
# Ink all cells on the current page
if @before_rendering_page
c = Cells.new(cells_this_page.map { |c, _| c })
@before_rendering_page.call(c)
end
Cell.draw_cells(cells_this_page)
cells_this_page = []
# start a new page or column
@pdf.bounds.move_past_bottom
if cell.row > 0 && @header
header_height = add_header(cells_this_page, @pdf.cursor, cell.row-1)
else
header_height = 0
end
offset = @pdf.y - cell.y - header_height
started_new_page_at_row = cell.row
end
# Don't modify cell.x / cell.y here, as we want to reuse the original
# values when re-inking the table. #draw should be able to be called
# multiple times.
x, y = cell.x, cell.y
y += offset
# Translate coordinates to the bounds we are in, since drawing is
# relative to the cursor, not ref_bounds.
x += @pdf.bounds.left_side - @pdf.bounds.absolute_left
y -= @pdf.bounds.absolute_bottom
# Set background color, if any.
if @row_colors && (!@header || cell.row > 0)
# Ensure coloring restarts on every page (to make sure the header
# and first row of a page are not colored the same way).
index = cell.row - [started_new_page_at_row, @header ? 1 : 0].max
cell.background_color ||= @row_colors[index % @row_colors.length]
end
cells_this_page << [cell, [x, y]]
last_y = y
end
# Draw the last page of cells
if @before_rendering_page
c = Cells.new(cells_this_page.map { |c, _| c })
Loading ...