class Prawn::Document::MultiBox

A MultiBox is specified by 2 Boxes and spans the areas between.

@group Experimental API

Attributes

@private

Public Class Methods

Source

# File lib/prawn/grid.rb, line 299
def initialize(pdf, box1, box2)
  @pdf = pdf
  @boxes = [box1, box2]
end

Public Instance Methods

bottom ()

Source

# File lib/prawn/grid.rb, line 364
def bottom
  bottom_box.bottom
end

y-coordinate of the bottom.

@return [Float]

bottom_left ()

Source

# File lib/prawn/grid.rb, line 385
def bottom_left
  [left, bottom]
end

x,y coordinates of bottom left corner.

@return [Array(Float, Float)]

bottom_right ()

Source

# File lib/prawn/grid.rb, line 392
def bottom_right
  [right, bottom]
end

x,y coordinates of bottom right corner.

@return [Array(Float, Float)]

bounding_box (&blk)

Source

# File lib/prawn/grid.rb, line 400
def bounding_box(&blk)
  pdf.bounding_box(top_left, width: width, height: height, &blk)
end

Creates a standard bounding box based on the grid box.

@yield @return [void]

gutter ()

Source

# File lib/prawn/grid.rb, line 336
def gutter
  @boxes[0].gutter
end

Width of the gutter.

@return [Float]

height ()

Source

# File lib/prawn/grid.rb, line 329
def height
  top_box.top - bottom_box.bottom
end

Height of a box.

@return [Float]

left ()

Source

# File lib/prawn/grid.rb, line 343
def left
  left_box.left
end

x-coordinate of left side.

@return [Float]

name ()

Source

# File lib/prawn/grid.rb, line 310
def name
  @boxes.map(&:name).join(':')
end

Mostly diagnostic method that outputs the name of a box.

@return [String]

right ()

Source

# File lib/prawn/grid.rb, line 350
def right
  right_box.right
end

x-coordinate of right side.

@return [Float]

show (grid_color = 'CCCCCC')

Source

# File lib/prawn/grid.rb, line 408
def show(grid_color = 'CCCCCC')
  bounding_box do
    original_stroke_color = pdf.stroke_color

    pdf.stroke_color = grid_color
    pdf.text(name)
    pdf.stroke_bounds

    pdf.stroke_color = original_stroke_color
  end
end

Drawn the box. Diagnostic method.

@param grid_color [Color] @return [void]

top ()

Source

# File lib/prawn/grid.rb, line 357
def top
  top_box.top
end

y-coordinate of the top.

@return [Float]

top_left ()

Source

# File lib/prawn/grid.rb, line 371
def top_left
  [left, top]
end

x,y coordinates of top left corner.

@return [Array(Float, Float)]

top_right ()

Source

# File lib/prawn/grid.rb, line 378
def top_right
  [right, top]
end

x,y coordinates of top right corner.

@return [Array(Float, Float)]

total_height ()

Source

# File lib/prawn/grid.rb, line 315
def total_height
  @boxes[0].total_height
end

@private

width ()

Source

# File lib/prawn/grid.rb, line 322
def width
  right_box.right - left_box.left
end

Width of a box.

@return [Float]