|
fop 1.1 | |||||||||
| 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.UnresolvedListElement
org.apache.fop.layoutmgr.BreakElement
public class BreakElement
This class represents an unresolved break possibility.
| Constructor Summary | |
|---|---|
BreakElement(Position position,
int penaltyWidth,
int penaltyValue,
int breakClass,
LayoutContext context)
Constructor for hard breaks. |
|
BreakElement(Position position,
int penaltyValue,
int breakClass,
LayoutContext context)
Create a new BreakElement for the given position, penaltyValue
and breakClass. |
|
BreakElement(Position position,
int penaltyValue,
LayoutContext context)
Main constructor |
|
| Method Summary | |
|---|---|
void |
clearPendingMarks()
Clears all pending marks associated with this break element. |
int |
getBreakClass()
Returns the break class of this penalty. |
int |
getPenaltyValue()
|
int |
getPenaltyWidth()
|
java.util.List |
getPendingAfterMarks()
|
java.util.List |
getPendingBeforeMarks()
|
boolean |
isConditional()
|
boolean |
isForcedBreak()
|
void |
setBreakClass(int breakClass)
Sets the break class. |
void |
setPenaltyValue(int p)
Sets the penalty value. |
java.lang.String |
toString()
|
| Methods inherited from class org.apache.fop.layoutmgr.UnresolvedListElement |
|---|
getOriginatingLayoutManager |
| Methods inherited from class org.apache.fop.layoutmgr.ListElement |
|---|
getLayoutManager, getPosition, isBox, isGlue, isPenalty, isUnresolvedElement, setPosition |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BreakElement(Position position,
int penaltyValue,
LayoutContext context)
position - the Position instance needed by the addAreas stage of the LMs.penaltyValue - the penalty value for the penalty element to be constructedcontext - the layout context which contains the pending conditional elements
public BreakElement(Position position,
int penaltyValue,
int breakClass,
LayoutContext context)
position, penaltyValue
and breakClass. (Used principally to generate break-possibilities in
ranges of content that must be kept together within the context corresponding
to the breakClass; expected to be one of
Constants.EN_AUTO,
Constants.EN_LINE,
Constants.EN_COLUMN or
Constants.EN_PAGE)
position - the corresponding PositionpenaltyValue - the penalty valuebreakClass - the break classcontext - the LayoutContext
public BreakElement(Position position,
int penaltyWidth,
int penaltyValue,
int breakClass,
LayoutContext context)
position - the Position instance needed by the addAreas stage of the LMs.penaltyWidth - the penalty widthpenaltyValue - the penalty value for the penalty element to be constructedbreakClass - 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)context - the layout context which contains the pending conditional elements| Method Detail |
|---|
public boolean isConditional()
isConditional in class UnresolvedListElementpublic int getPenaltyWidth()
public int getPenaltyValue()
public void setPenaltyValue(int p)
p - the new penalty valuepublic boolean isForcedBreak()
isForcedBreak in class ListElementpublic int getBreakClass()
Constants.EN_AUTO,
Constants.EN_COLUMN,
Constants.EN_PAGE,
Constants.EN_EVEN_PAGE,
Constants.EN_ODD_PAGE.public void setBreakClass(int breakClass)
breakClass - one of
Constants.EN_AUTO,
Constants.EN_COLUMN,
Constants.EN_PAGE,
Constants.EN_EVEN_PAGE,
Constants.EN_ODD_PAGE.public java.util.List getPendingBeforeMarks()
public java.util.List getPendingAfterMarks()
public void clearPendingMarks()
public java.lang.String toString()
toString in class java.lang.Object
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||