Class: HexaPDF::Layout::TextLayouter::Penalty

Inherits:

Object

• Object
• HexaPDF::Layout::TextLayouter::Penalty

Defined in:

lib/hexapdf/layout/text_layouter.rb

Overview

Used for layouting. Describes a penalty item, i.e. a point where a break is allowed.

If the penalty is greater than or equal to INFINITY, a break is forbidden. If it is smaller than or equal to -INFINITY, a break is mandatory.

If a penalty contains an item and a break occurs at the penalty (taking the width of the penalty/item into account), then the penality item must be the last item of the line.

Constant Summary

INFINITY =

All numbers greater than this one are deemed infinite.

1000

PARAGRAPH_BREAK =

The penalty value for a mandatory paragraph break.

- 1_000_000

LINE_BREAK =

The penalty value for a mandatory line break.

- 1_000_001

MandatoryParagraphBreak =

Singleton object describing a Penalty for a mandatory paragraph break.

new(PARAGRAPH_BREAK)

MandatoryLineBreak =

Singleton object describing a Penalty for a mandatory line break.

new(LINE_BREAK)

ProhibitedBreak =

Singleton object describing a Penalty for a prohibited break.

new(Penalty::INFINITY)

Standard =

Singleton object describing a standard Penalty, e.g. for hyphens.

new(50)

Instance Attribute Summary

• #item ⇒ Object readonly

  The wrapped item.

• #penalty ⇒ Object readonly

  The penalty for breaking at this point.

• #width ⇒ Object readonly

  The width assigned to this item.

Instance Method Summary

• #initialize(penalty, width = 0, item: nil) ⇒ Penalty constructor

  Creates a new Penalty with the given penality.

• #type ⇒ Object

  Returns :penalty.

Constructor Details

#initialize(penalty, width = 0, item: nil) ⇒ Penalty

Creates a new Penalty with the given penality.

# File 'lib/hexapdf/layout/text_layouter.rb', line 162

def initialize(penalty, width = 0, item: nil)
  @penalty = penalty
  @width = width
  @item = item
end

Instance Attribute Details

#item ⇒ Object (readonly)

The wrapped item.

# File 'lib/hexapdf/layout/text_layouter.rb', line 159

def item
  @item
end

#penalty ⇒ Object (readonly)

The penalty for breaking at this point.

# File 'lib/hexapdf/layout/text_layouter.rb', line 153

def penalty
  @penalty
end

#width ⇒ Object (readonly)

The width assigned to this item.

# File 'lib/hexapdf/layout/text_layouter.rb', line 156

def width
  @width
end

Instance Method Details

#type ⇒ Object

Returns :penalty.

# File 'lib/hexapdf/layout/text_layouter.rb', line 169

def type
  :penalty
end