Class: Prawn::Document::Grid
- Inherits:
-
Object
- Object
- Prawn::Document::Grid
- Defined in:
- lib/prawn/layout/grid.rb
Overview
A Grid represents the entire grid system of a Page and calculates the column width and row height of the base box.
Instance Attribute Summary collapse
-
#column_gutter ⇒ Object
readonly
Returns the value of attribute column_gutter.
-
#columns ⇒ Object
readonly
Returns the value of attribute columns.
-
#gutter ⇒ Object
readonly
Returns the value of attribute gutter.
-
#pdf ⇒ Object
readonly
Returns the value of attribute pdf.
-
#row_gutter ⇒ Object
readonly
Returns the value of attribute row_gutter.
-
#rows ⇒ Object
readonly
Returns the value of attribute rows.
Instance Method Summary collapse
-
#column_width ⇒ Object
Calculates the base width of boxes.
-
#initialize(pdf, options = {}) ⇒ Grid
constructor
:nodoc:.
-
#row_height ⇒ Object
Calculates the base height of boxes.
-
#show_all(color = "CCCCCC") ⇒ Object
Diagnostic tool to show all of the grids.
Constructor Details
Instance Attribute Details
#column_gutter ⇒ Object (readonly)
Returns the value of attribute column_gutter.
37 38 39 |
# File 'lib/prawn/layout/grid.rb', line 37 def column_gutter @column_gutter end |
#columns ⇒ Object (readonly)
Returns the value of attribute columns.
37 38 39 |
# File 'lib/prawn/layout/grid.rb', line 37 def columns @columns end |
#gutter ⇒ Object (readonly)
Returns the value of attribute gutter.
37 38 39 |
# File 'lib/prawn/layout/grid.rb', line 37 def gutter @gutter end |
#pdf ⇒ Object (readonly)
Returns the value of attribute pdf.
37 38 39 |
# File 'lib/prawn/layout/grid.rb', line 37 def pdf @pdf end |
#row_gutter ⇒ Object (readonly)
Returns the value of attribute row_gutter.
37 38 39 |
# File 'lib/prawn/layout/grid.rb', line 37 def row_gutter @row_gutter end |
#rows ⇒ Object (readonly)
Returns the value of attribute rows.
37 38 39 |
# File 'lib/prawn/layout/grid.rb', line 37 def rows @rows end |
Instance Method Details
#column_width ⇒ Object
Calculates the base width of boxes.
49 50 51 |
# File 'lib/prawn/layout/grid.rb', line 49 def column_width @column_width ||= subdivide(pdf.bounds.width, columns, column_gutter) end |
#row_height ⇒ Object
Calculates the base height of boxes.
54 55 56 |
# File 'lib/prawn/layout/grid.rb', line 54 def row_height @row_height ||= subdivide(pdf.bounds.height, rows, row_gutter) end |
#show_all(color = "CCCCCC") ⇒ Object
Diagnostic tool to show all of the grids. Defaults to gray.
59 60 61 62 63 64 65 |
# File 'lib/prawn/layout/grid.rb', line 59 def show_all(color = "CCCCCC") self.rows.times do |i| self.columns.times do |j| pdf.grid(i,j).show(color) end end end |