org.axsl.linebreak

Interface LbPenalty

All Superinterfaces:

LbContent

public interface LbPenalty
extends LbContent

A "penalty" in the Knuth-Plass linebreaking model, this is actually a potential linebreak.

Method Summary

Modifier and Type	Method and Description
int	getPenalty() The aesthetic cost of breaking a line at this point.
int	getWidth() The width of this penalty item, in millipoints.
boolean	isFlagged() Indicates whether this penalty is "flagged" or not.

Method Detail

getPenalty

int getPenalty()

The aesthetic cost of breaking a line at this point. A high value indicates a poor place to break a line, with any value greater than or equal to 1000 treated as infinitely bad, and therefore always prohibited. A low value indicates a good place to break a line, with any value less than or equal to -1000 treated as infinitely good, and therefore forced.

Returns:

The penalty value for this item.

getWidth

int getWidth()

The width of this penalty item, in millipoints. If a line break occurs at this opportunity, additional typeset material of this width will be added to the line just before the break occurs. For example, if a word might be hyphenated at this point, the width of the hyphen should be returned here.

Returns:

The width of any additional typset material if this linbreak opportunity is chosen.

isFlagged

boolean isFlagged()

Indicates whether this penalty is "flagged" or not. An example of a flagged item is an optional linebreak resulting from hyphenation. Special rules apply to these items: for example, we avoid allowing two consecutive flagged items.

Returns:

True iff this penalty is "flagged".