Class: Prawn::Document::ColumnBox

Inherits:
BoundingBox show all
Defined in:
lib/prawn/document/column_box.rb

Overview

Implements the necessary functionality to allow #column_box to work.

Experimental API collapse

Constructor Details

#initialize(document, parent, point, options = {}) ⇒ ColumnBox

Returns a new instance of ColumnBox.

Parameters:

  • point (Array(Number, Number))
  • options (Hash{Symbol => any}) (defaults to: {})

Options Hash (options):

  • :width (Number) —

    width of the new column box, must be specified.

  • :height (Number) —

    height of the new column box, stretchy box if omitted.

  • :columns (Integer) — default: 3
  • :spacer (Number) — default: font_size
  • :reflow_margins (Boolean) — default: false
Source Code
lib/prawn/document/column_box.rb, line 68
68
def initialize(document, parent, point, options = {})

69
  super

70
  @columns = options[:columns] || 3

71
  @spacer = options[:spacer] || @document.font_size

72
  @current_column = 0

73
  @reflow_margins = options[:reflow_margins]

74
end

Instance Method Details

#bare_column_width ⇒ Number

The column width, not the width of the whole box, before left and/or right padding.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 80
80
def bare_column_width

81
  (@width - (@spacer * (@columns - 1))) / @columns

82
end

#left ⇒ Number

Relative position of the left edge of the current column.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 109
109
def left

110
  width_of_column * @current_column

111
end

#left_side ⇒ Number

x coordinate of the left edge of the current column.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 102
102
def left_side

103
  absolute_left + (width_of_column * @current_column)

104
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.

Source Code
lib/prawn/document/column_box.rb, line 132
132
def move_past_bottom

133
  @current_column = (@current_column + 1) % @columns

134
  @document.y = @y

135
  if @current_column.zero?

136
    if @reflow_margins

137
      @y = @parent.absolute_top

138
    end

139
    @document.start_new_page

140
  end

141
end

#right ⇒ Number

Relative position of the right edge of the current column.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 124
124
def right

125
  left + width

126
end

#right_side ⇒ Number

x coordinate of the right edge of the current column.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 116
116
def right_side

117
  columns_from_right = @columns - (1 + @current_column)

118
  absolute_right - (width_of_column * columns_from_right)

119
end

#width ⇒ Number

The column width after padding. Used to calculate how long a line of text can be.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 88
88
def width

89
  bare_column_width - (@total_left_padding + @total_right_padding)

90
end

#width_of_column ⇒ Number

Column width including the spacer.

Returns:

  • (Number)
Source Code
lib/prawn/document/column_box.rb, line 95
95
def width_of_column

96
  bare_column_width + @spacer

97
end