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
private int	context
static Keep	KEEP_ALWAYS	keep always
static Keep	KEEP_AUTO	keep auto
private int	strength
private static int	STRENGTH_ALWAYS	The integer value for "always" keep strength.
private static int	STRENGTH_AUTO	The integer value for "auto" keep strength.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Keep(int strength, int context)

Method Summary

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 same
int	getContext()	Returns the context of this keep.
static Keep	getKeep(KeepProperty keepProperty)	Obtain a Keep instance corresponding to the given KeepProperty
private static int	getKeepContextPriority(int context)
private static int	getKeepStrength(Property keep)
int	getPenalty()
boolean	isAuto()
java.lang.String	toString()
private void	update(Property keep, int context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STRENGTH_AUTO

private static final int STRENGTH_AUTO

The integer value for "auto" keep strength.

See Also:

Constant Field Values

STRENGTH_ALWAYS

private static final int STRENGTH_ALWAYS

The integer value for "always" keep strength.

See Also:

Constant Field Values

KEEP_AUTO

public static final Keep KEEP_AUTO

keep auto

KEEP_ALWAYS

public static final Keep KEEP_ALWAYS

keep always

strength

private int strength

context

private int context

Constructor Detail

Keep

private Keep(int strength,
             int context)

Method Detail

getKeepStrength

private static int getKeepStrength(Property keep)

getKeep

public static Keep getKeep(KeepProperty keepProperty)

Obtain a Keep instance corresponding to the given KeepProperty

Parameters:

keepProperty - the KeepProperty

Returns:

a new instance corresponding to the given property

update

private void update(Property keep,
                    int context)

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 or Constants.EN_PAGE

getPenalty

public int getPenalty()

Returns:

the penalty value corresponding to the strength of this Keep

getKeepContextPriority

private static int getKeepContextPriority(int context)

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 class java.lang.Object