|
fop 0.95 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.fop.layoutmgr.ListElement
org.apache.fop.layoutmgr.KnuthElement
org.apache.fop.layoutmgr.KnuthPenalty
An instance of this class represents information about a feasible breaking point; it does not represent any piece of content. A KnuthPenalty is a feasible breaking point unless its value is infinity; a KnuthPenalty whose value is -infinity represents a forced break. A KnuthPenalty is suppressed, and its width is ignored, if it is not a chosen breaking point; for example, a KnuthPenalty representing a hyphenation point has a width (the "-" width), which must be ignored if that point is not chosen as a breaking point. Besides the inherited methods and attributes, this class has two more attributes and the methods used to get them: the penalty value, which is a kind of "aesthetic cost" (the higher the value, the more unsightly the breaking point), and a boolean that marks KnuthPenalties which should not be chosen as breaking points for consecutive lines.
| Field Summary | |
static int |
FLAGGED_PENALTY
Used for flagged penalties. |
| Fields inherited from class org.apache.fop.layoutmgr.KnuthElement |
INFINITE |
| Constructor Summary | |
KnuthPenalty(int w,
int p,
boolean f,
int iBreakClass,
Position pos,
boolean bAux)
Create a new KnuthPenalty. |
|
KnuthPenalty(int w,
int p,
boolean f,
Position pos,
boolean bAux)
Create a new KnuthPenalty. |
|
| Method Summary | |
int |
getBreakClass()
|
int |
getP()
|
boolean |
isFlagged()
|
boolean |
isForcedBreak()
|
boolean |
isPenalty()
|
void |
setBreakClass(int cl)
Sets the break class for this penalty. |
void |
setP(int p)
Sets a new penalty value. |
java.lang.String |
toString()
|
| Methods inherited from class org.apache.fop.layoutmgr.KnuthElement |
getW, getY, getZ, isAuxiliary, isUnresolvedElement |
| Methods inherited from class org.apache.fop.layoutmgr.ListElement |
getLayoutManager, getPosition, isBox, isGlue, setPosition |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final int FLAGGED_PENALTY
| Constructor Detail |
public KnuthPenalty(int w,
int p,
boolean f,
Position pos,
boolean bAux)
w - the width of this penaltyp - the penalty value of this penaltyf - is this penalty flagged?pos - the Position stored in this penaltybAux - is this penalty auxiliary?
public KnuthPenalty(int w,
int p,
boolean f,
int iBreakClass,
Position pos,
boolean bAux)
w - the width of this penaltyp - the penalty value of this penaltyf - is this penalty flagged?iBreakClass - the break class of this penalty (one of
Constants.EN_AUTO, Constants.EN_COLUMN, Constants.EN_PAGE,
Constants.EN_EVEN_PAGE, Constants.EN_ODD_PAGE)pos - the Position stored in this penaltybAux - is this penalty auxiliary?| Method Detail |
public boolean isPenalty()
isPenalty in class ListElementpublic int getP()
getP in class KnuthElementpublic void setP(int p)
p - the new penalty valuepublic boolean isFlagged()
public boolean isForcedBreak()
isForcedBreak in class ListElementpublic int getBreakClass()
public void setBreakClass(int cl)
cl - the break class (EN_AUTO, EN_COLUMN, EN_PAGE, EN_EVEN_PAGE, EN_ODD_PAGE)public java.lang.String toString()
|
fop 0.95 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||