Class: HexaPDF::Layout::ListBox

Inherits:
Box
  • Object
show all
Defined in:
lib/hexapdf/layout/list_box.rb

Overview

A ListBox arranges its children as unordered or ordered list items.

The indentation of the contents from the left (#content_indentation) as well as the marker type of the items (#marker_type) can be specified. Additionally, it is possible to define the start number for ordered lists (#start_number) and the amount of spacing between items (#item_spacing).

If the list box has padding and/or borders specified, they are handled like with any other box. This means they are around all items and their contents and are not used separately for each item.

The following style properties are used (additionally to those used by the parent class):

Style#position

If this is set to :flow, the frames created for the list items will take the shape of the frame into account. This also means that the available_width and available_height arguments are ignored.

Defined Under Namespace

Classes: ItemResult

Constant Summary

Constants included from Utils

Utils::EPSILON

Instance Attribute Summary collapse

Attributes inherited from Box

#fit_result, #height, #properties, #style, #width

Instance Method Summary collapse

Methods inherited from Box

#content_height, #content_width, create, #draw, #fit, #split, #split_box?

Constructor Details

#initialize(children: [], marker_type: :disc, content_indentation: nil, start_number: 1, item_spacing: 0, **kwargs) ⇒ ListBox

Creates a new ListBox object for the given child boxes in children.



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/hexapdf/layout/list_box.rb', line 166

def initialize(children: [], marker_type: :disc, content_indentation: nil, start_number: 1,
               item_spacing: 0, **kwargs)
  super(**kwargs)
  @children = children
  @marker_type = marker_type
  @content_indentation = content_indentation || 2 * style.font_size
  @start_number = start_number
  @item_spacing = item_spacing

  @results = nil
  @results_item_marker_x = nil
end

Instance Attribute Details

#children ⇒ Object (readonly)

The child boxes of this ListBox. They need to be finalized before #fit is called.



68
69
70
 
# File 'lib/hexapdf/layout/list_box.rb', line 68

def children
  @children
end

#content_indentation ⇒ Object (readonly)

The indentation of the list content in PDF points. The item marker will be inside this indentation.

The default value is two times the font size.

Example:

#>pdf-composer100
composer.box(:list) {|list| list.lorem_ipsum_box(sentences: 1) }
composer.box(:list, content_indentation: 50) do |list|
  list.lorem_ipsum_box(sentences: 1)
end



151
152
153
 
# File 'lib/hexapdf/layout/list_box.rb', line 151

def content_indentation
  @content_indentation
end

#item_spacing ⇒ Object (readonly)

The spacing between two consecutive list items.

The default value is zero.

Example:

#>pdf-composer
composer.box(:list, item_spacing: 10) do |list|
  3.times { list.lorem_ipsum_box(sentences: 1) }
end



163
164
165
 
# File 'lib/hexapdf/layout/list_box.rb', line 163

def item_spacing
  @item_spacing
end

#marker_type ⇒ Object (readonly)

The type of list item marker to be rendered before the list item contents.

The following values are supported (and :disc is the default):

:disc

Draws a filled disc for the items of the unordered list.

#>pdf-composer100
composer.box(:list, marker_type: :disc) do |list|
  list.lorem_ipsum_box(sentences: 1)
end
:circle

Draws an unfilled circle for the items of the unordered list.

#>pdf-composer100
composer.box(:list, marker_type: :circle) do |list|
  list.lorem_ipsum_box(sentences: 1)
end
:square

Draws a filled square for the items of the unordered list.

#>pdf-composer100
composer.box(:list, marker_type: :square) do |list|
  list.lorem_ipsum_box(sentences: 1)
end
:decimal

Draws the numbers in decimal form, starting from #start_number) for the items of the ordered list.

#>pdf-composer100
composer.box(:list, marker_type: :decimal) do |list|
  5.times { list.lorem_ipsum_box(sentences: 1) }
end
custom marker

Additionally, it is possible to specify an object as value that responds to #call(document, box, index) where document is the HexaPDF::Document, box is the list box, and index is the current item index, starting at 0. The return value needs to be a Box object which is then fit into the content indentation area and drawn.

#>pdf-composer100
image = lambda do |document, box, index|
  document.layout.image_box(machu_picchu, height: box.style.font_size)
end
composer.box(:list, marker_type: image) do |list|
  2.times { list.lorem_ipsum_box(sentences: 1) }
end



125
126
127
 
# File 'lib/hexapdf/layout/list_box.rb', line 125

def marker_type
  @marker_type
end

#start_number ⇒ Object (readonly)

The start number when using a #marker_type that represents an ordered list.

The default value for this is 1.

Example:

#>pdf-composer100
composer.box(:list, marker_type: :decimal, start_number: 3) do |list|
  2.times { list.lorem_ipsum_box(sentences: 1) }
end



137
138
139
 
# File 'lib/hexapdf/layout/list_box.rb', line 137

def start_number
  @start_number
end

Instance Method Details

#empty? ⇒ Boolean

Returns true if no box was fitted into the list box.

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/hexapdf/layout/list_box.rb', line 185

def empty?
  super && (!@results || @results.all? {|result| result.box_fitter.fit_results.empty? })
end

#supports_position_flow? ⇒ Boolean

Returns true as the ‘position’ style property value :flow is supported.

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/hexapdf/layout/list_box.rb', line 180

def supports_position_flow?
  true
end