Package org.apache.fop.layoutmgr
Class Keep
- java.lang.Object
-
- org.apache.fop.layoutmgr.Keep
-
public final class Keep extends java.lang.Object
Object representing a keep constraint, corresponding to the XSL-FO keep properties.
-
-
Field Summary
Fields Modifier and Type Field Description static Keep
KEEP_ALWAYS
keep alwaysstatic Keep
KEEP_AUTO
keep auto
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Keep
compare(Keep other)
Compare this Keep instance to another one, and return the stronger one if the context is the sameint
getContext()
Returns the context of this keep.static Keep
getKeep(KeepProperty keepProperty)
Obtain a Keep instance corresponding to the givenKeepProperty
int
getPenalty()
boolean
isAuto()
java.lang.String
toString()
-
-
-
Method Detail
-
getKeep
public static Keep getKeep(KeepProperty keepProperty)
Obtain a Keep instance corresponding to the givenKeepProperty
- Parameters:
keepProperty
- theKeepProperty
- Returns:
- a new instance corresponding to the given property
-
isAuto
public boolean isAuto()
- Returns:
true
if the keep property was specified as "auto"
-
getContext
public int getContext()
Returns the context of this keep.- Returns:
- one of
Constants.EN_LINE
,Constants.EN_COLUMN
orConstants.EN_PAGE
-
getPenalty
public int getPenalty()
- Returns:
- the penalty value corresponding to the strength of this Keep
-
compare
public Keep compare(Keep other)
Compare this Keep instance to another one, and return the stronger one if the context is the same- Parameters:
other
- the instance to compare to- Returns:
- the winning Keep instance
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-