Class: Prawn::Text::Box

Inherits:
Formatted::Box show all
Defined in:
lib/prawn/text/box.rb

Overview

Generally, one would use the Prawn::Text#text_box convenience method. However, using Text::Box.new in conjunction with #render(:dry_run=> true) enables one to do look-ahead calculations prior to placing text on the page, or to determine how much vertical space was consumed by the printed text

Instance Attribute Summary

Attributes inherited from Formatted::Box

#ascender, #at, #descender, #leading, #line_height, #text

Experimental API (collapse)

Methods inherited from Formatted::Box

#available_width, #draw_fragment, #everything_printed?, extensions, #height, #line_gap, #nothing_printed?, #valid_options

Constructor Details

- (Box) initialize(string, options = {})

Returns a new instance of Box



128
129
130
# File 'lib/prawn/text/box.rb', line 128

def initialize(string, options = {})
  super([{ :text => string }], options)
end

Instance Method Details

- (Object) render(flags = {})



132
133
134
135
# File 'lib/prawn/text/box.rb', line 132

def render(flags = {})
  leftover = super(flags)
  leftover.collect { |hash| hash[:text] }.join
end