Class: Prawn::Document::ColumnBox
- Inherits:
-
BoundingBox
- Object
- BoundingBox
- Prawn::Document::ColumnBox
- Defined in:
- lib/prawn/document/column_box.rb
Overview
Implements the necessary functionality to allow #column_box to work.
Experimental API collapse
-
#bare_column_width ⇒ Number
The column width, not the width of the whole box, before left and/or right padding.
-
#initialize(document, parent, point, options = {}) ⇒ ColumnBox
constructor
A new instance of ColumnBox.
-
#left ⇒ Number
Relative position of the left edge of the current column.
-
#left_side ⇒ Number
x coordinate of the left edge of the current column.
-
#move_past_bottom ⇒ void
Moves to the next column or starts a new page if currently positioned at the rightmost column.
-
#right ⇒ Number
Relative position of the right edge of the current column.
-
#right_side ⇒ Number
x coordinate of the right edge of the current column.
-
#width ⇒ Number
The column width after padding.
-
#width_of_column ⇒ Number
Column width including the spacer.
Constructor Details
#initialize(document, parent, point, options = {}) ⇒ ColumnBox
Returns a new instance of ColumnBox.
68 69 70 71 72 73 74 |
# File 'lib/prawn/document/column_box.rb', line 68 def initialize(document, parent, point, = {}) super @columns = [:columns] || 3 @spacer = [:spacer] || @document.font_size @current_column = 0 @reflow_margins = [:reflow_margins] end |
Instance Method Details
#bare_column_width ⇒ Number
The column width, not the width of the whole box, before left and/or right padding.
80 81 82 |
# File 'lib/prawn/document/column_box.rb', line 80 def (@width - (@spacer * (@columns - 1))) / @columns end |
#left ⇒ Number
Relative position of the left edge of the current column.
109 110 111 |
# File 'lib/prawn/document/column_box.rb', line 109 def left width_of_column * @current_column end |
#left_side ⇒ Number
x coordinate of the left edge of the current column.
102 103 104 |
# File 'lib/prawn/document/column_box.rb', line 102 def left_side absolute_left + (width_of_column * @current_column) end |
#move_past_bottom ⇒ void
This method returns an undefined value.
Moves to the next column or starts a new page if currently positioned at the rightmost column.
132 133 134 135 136 137 138 139 140 141 |
# File 'lib/prawn/document/column_box.rb', line 132 def move_past_bottom @current_column = (@current_column + 1) % @columns @document.y = @y if @current_column.zero? if @reflow_margins @y = @parent.absolute_top end @document.start_new_page end end |
#right ⇒ Number
Relative position of the right edge of the current column.
124 125 126 |
# File 'lib/prawn/document/column_box.rb', line 124 def right left + width end |
#right_side ⇒ Number
x coordinate of the right edge of the current column.
116 117 118 119 |
# File 'lib/prawn/document/column_box.rb', line 116 def right_side columns_from_right = @columns - (1 + @current_column) absolute_right - (width_of_column * columns_from_right) end |
#width ⇒ Number
The column width after padding. Used to calculate how long a line of text can be.
88 89 90 |
# File 'lib/prawn/document/column_box.rb', line 88 def width - (@total_left_padding + @total_right_padding) end |
#width_of_column ⇒ Number
Column width including the spacer.
95 96 97 |
# File 'lib/prawn/document/column_box.rb', line 95 def width_of_column + @spacer end |