org.apache.fop.layoutmgr

Class KnuthElement

java.lang.Object

org.apache.fop.layoutmgr.ListElement

org.apache.fop.layoutmgr.KnuthElement

Direct Known Subclasses:

KnuthBox, KnuthGlue, KnuthPenalty

public abstract class KnuthElement
extends ListElement

This is the super class for KnuthBox, KnuthGlue and KnuthPenalty. It stores information common to all sub classes, and the methods to get it: the width, a Position and a boolean marking KnuthElements used for some special feature (for example, the additional elements used to represent a space when text alignment is right, left or center).

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITE The value used as an infinite indicator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KnuthElement(int w, Position pos, boolean bAux) Create a new KnuthElement.

Method Summary

Methods

Modifier and Type	Method and Description
int	getP()
int	getW()
int	getY()
int	getZ()
boolean	isAuxiliary()
boolean	isUnresolvedElement()

Methods inherited from class org.apache.fop.layoutmgr.ListElement

getLayoutManager, getPosition, isBox, isForcedBreak, isGlue, isPenalty, setPosition

Methods inherited from class java.lang.Object

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

Field Detail

INFINITE

public static final int INFINITE

The value used as an infinite indicator.

See Also:

Constant Field Values

Constructor Detail

KnuthElement

protected KnuthElement(int w,
            Position pos,
            boolean bAux)

Create a new KnuthElement. This class being abstract, this can be called only by subclasses.

Parameters:

w - the width of this element

pos - the Position stored in this element

bAux - is this an auxiliary element?

Method Detail

isAuxiliary

public boolean isAuxiliary()

Returns:

true if this element is an auxiliary one.

getW

public int getW()

Returns:

the width of this element.

getP

public int getP()

Returns:

the penalty value of this element, if applicable.

getY

public int getY()

Returns:

the stretch value of this element, if applicable.

getZ

public int getZ()

Returns:

the shrink value of this element, if applicable.

isUnresolvedElement

public boolean isUnresolvedElement()

Overrides:

isUnresolvedElement in class ListElement

Returns:

true if the element is an unresolved element such as a space or a border.