Class: Prawn::Table::Cells
- Inherits:
-
Array
- Object
- Array
- Prawn::Table::Cells
- Defined in:
- lib/prawn/table/cells.rb
Overview
Represents a selection of cells to be styled. Operations on a CellProxy can be chained, and cell properties can be set one-for-all on the proxy.
To set vertical borders only:
table.cells.borders = [:left, :right]
To highlight a rectangular area of the table:
table.rows(1..3).columns(2..4).background_color = 'ff0000'
Instance Method Summary collapse
-
#[](row, col) ⇒ Object
Retrieves a cell based on its 0-based row and column.
-
#[]=(row, col, cell) ⇒ Object
Puts a cell in the collection at the given position.
-
#columns(col_spec) ⇒ Object
(also: #column)
Limits selection to the given column or columns.
-
#filter(&block) ⇒ Object
Allows you to filter the given cells by arbitrary properties.
-
#height ⇒ Object
Returns the total height of all rows in the selected set.
-
#max_width ⇒ Object
Returns maximum width that can contain cells in the set.
-
#method_missing(id, *args, &block) ⇒ Object
Supports setting arbitrary properties on a group of cells.
-
#min_width ⇒ Object
Returns minimum width required to contain cells in the set.
-
#rows(row_spec) ⇒ Object
(also: #row)
Limits selection to the given row or rows.
-
#style(options = {}, &block) ⇒ Object
Supports setting multiple properties at once.
-
#width ⇒ Object
Returns the total width of all columns in the selected set.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(id, *args, &block) ⇒ Object
Supports setting arbitrary properties on a group of cells.
table.cells.row(3..6).background_color = 'cc0000'
159 160 161 162 163 164 165 |
# File 'lib/prawn/table/cells.rb', line 159 def method_missing(id, *args, &block) if id.to_s =~ /=\z/ each { |c| c.send(id, *args, &block) if c.respond_to?(id) } else super end end |
Instance Method Details
#[](row, col) ⇒ Object
Retrieves a cell based on its 0-based row and column. Returns an individual Cell, not a Cells collection.
table.cells[0, 0].content # => "First cell content"
87 88 89 |
# File 'lib/prawn/table/cells.rb', line 87 def [](row, col) find { |c| c.row == row && c.column == col } end |
#[]=(row, col, cell) ⇒ Object
Puts a cell in the collection at the given position. Internal use only.
93 94 95 96 97 98 99 |
# File 'lib/prawn/table/cells.rb', line 93 def []=(row, col, cell) # :nodoc: cell.extend(Cell::InTable) cell.row = row cell.column = col self << cell end |
#columns(col_spec) ⇒ Object Also known as: column
Limits selection to the given column or columns. col_spec
can be anything that responds to the === operator selecting a set of 0-based column numbers; most commonly a number or a range.
table.column(0) # selects first column
table.columns(3..4) # selects columns four and five
64 65 66 67 68 69 70 |
# File 'lib/prawn/table/cells.rb', line 64 def columns(col_spec) index_cells unless @indexed col_spec = transform_spec(col_spec, @column_count) Cells.new(@columns[col_spec] ||= select { |c| col_spec.respond_to?(:include?) ? col_spec.include?(c.column) : col_spec === c.column }) end |
#filter(&block) ⇒ Object
Allows you to filter the given cells by arbitrary properties.
table.column(4).filter { |cell| cell.content =~ /Yes/ }.
background_color = '00ff00'
78 79 80 |
# File 'lib/prawn/table/cells.rb', line 78 def filter(&block) Cells.new(select(&block)) end |
#height ⇒ Object
Returns the total height of all rows in the selected set.
151 152 153 |
# File 'lib/prawn/table/cells.rb', line 151 def height aggregate_cell_values(:row, :height_ignoring_span, :max) end |
#max_width ⇒ Object
Returns maximum width that can contain cells in the set.
145 146 147 |
# File 'lib/prawn/table/cells.rb', line 145 def max_width aggregate_cell_values(:column, :max_width_ignoring_span, :min) end |
#min_width ⇒ Object
Returns minimum width required to contain cells in the set.
139 140 141 |
# File 'lib/prawn/table/cells.rb', line 139 def min_width aggregate_cell_values(:column, :avg_spanned_min_width, :max) end |
#rows(row_spec) ⇒ Object Also known as: row
Limits selection to the given row or rows. row_spec
can be anything that responds to the === operator selecting a set of 0-based row numbers; most commonly a number or a range.
table.row(0) # selects first row
table.rows(3..4) # selects rows four and five
48 49 50 51 52 53 54 |
# File 'lib/prawn/table/cells.rb', line 48 def rows(row_spec) index_cells unless @indexed row_spec = transform_spec(row_spec, @row_count) Cells.new(@rows[row_spec] ||= select { |c| row_spec.respond_to?(:include?) ? row_spec.include?(c.row) : row_spec === c.row }) end |
#style(options = {}, &block) ⇒ Object
Supports setting multiple properties at once.
table.cells.style(:padding => 0, :border_width => 2)
is the same as:
table.cells.padding = 0
table.cells.border_width = 2
You can also pass a block, which will be called for each cell in turn. This allows you to set more complicated properties:
table.cells.style { |cell| cell.border_width += 12 }
115 116 117 118 119 120 |
# File 'lib/prawn/table/cells.rb', line 115 def style(={}, &block) each do |cell| next if cell.is_a?(Cell::SpanDummy) cell.style(, &block) end end |
#width ⇒ Object
Returns the total width of all columns in the selected set.
124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/prawn/table/cells.rb', line 124 def width widths = {} each do |cell| index = cell.column per_cell_width = cell.width_ignoring_span.to_f / cell.colspan cell.colspan.times do |n| widths[cell.column+n] = [widths[cell.column+n], per_cell_width]. compact.max end end widths.values.inject(0, &:+) end |