org.jfree.layouting.input.style

Class StyleKey

public final class StyleKey extends Object implements Serializable, Cloneable

Creation-Date: 26.10.2005, 14:05:23

Author: Thomas Morgner

Field Summary
static intAll_ELEMENTS
static intALWAYS
static intBLOCK_ELEMENTS
static intCOUNTERS
static intDOM_ELEMENTS
static intFOOTNOTE_AREA
intindex
The index is implicitly defined when the key is registered.
static intINLINE_ELEMENTS
static intMARGINS
static intPAGE_CONTEXT
static intPSEUDO_AFTER
static intPSEUDO_ALTERNATE
static intPSEUDO_BEFORE
static intPSEUDO_FIRST_LETTER
static intPSEUDO_FIRST_LINE
static intPSEUDO_LINEMARKER
static intPSEUDO_MARKER
static intPSEUDO_OTHER
Constructor Summary
protected StyleKey(String name, boolean trans, boolean inherited, int index, int validity)
Creates a new style key.
Method Summary
Objectclone()
booleanequals(Object o)
Indicates whether some other object is "equal to" this one.
intgetIndex()
StringgetName()
Returns the name of the key.
inthashCode()
Returns a hash code value for the object.
booleanisInherited()
booleanisTransient()
Checks, whether this stylekey denotes a temporary computation result.
booleanisValidOn(int mask)
StringtoString()
Returns a string representation of the object.

Field Detail

All_ELEMENTS

public static final int All_ELEMENTS

ALWAYS

public static final int ALWAYS

BLOCK_ELEMENTS

public static final int BLOCK_ELEMENTS

COUNTERS

public static final int COUNTERS

DOM_ELEMENTS

public static final int DOM_ELEMENTS

FOOTNOTE_AREA

public static final int FOOTNOTE_AREA

index

public final int index
The index is implicitly defined when the key is registered. Do not rely on that index for long term persitence.

INLINE_ELEMENTS

public static final int INLINE_ELEMENTS

MARGINS

public static final int MARGINS

PAGE_CONTEXT

public static final int PAGE_CONTEXT

PSEUDO_AFTER

public static final int PSEUDO_AFTER

PSEUDO_ALTERNATE

public static final int PSEUDO_ALTERNATE

PSEUDO_BEFORE

public static final int PSEUDO_BEFORE

PSEUDO_FIRST_LETTER

public static final int PSEUDO_FIRST_LETTER

PSEUDO_FIRST_LINE

public static final int PSEUDO_FIRST_LINE

PSEUDO_LINEMARKER

public static final int PSEUDO_LINEMARKER

PSEUDO_MARKER

public static final int PSEUDO_MARKER

PSEUDO_OTHER

public static final int PSEUDO_OTHER

Constructor Detail

StyleKey

protected StyleKey(String name, boolean trans, boolean inherited, int index, int validity)
Creates a new style key.

Parameters: name the name (never null).

Method Detail

clone

public Object clone()

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one.

Parameters: o the reference object with which to compare.

Returns: true if this object is the same as the obj argument; false otherwise.

getIndex

public int getIndex()

getName

public String getName()
Returns the name of the key.

Returns: the name.

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Returns: a hash code value for this object.

isInherited

public boolean isInherited()

isTransient

public boolean isTransient()
Checks, whether this stylekey denotes a temporary computation result.

Returns: true, if the key is transient, false otherwise.

isValidOn

public boolean isValidOn(int mask)

toString

public String toString()
Returns a string representation of the object.

Returns: a string representation of the object.