org.foray.area
Enum AreaClass

java.lang.Object
  java.lang.Enum<AreaClass>
      org.foray.area.AreaClass

All Implemented Interfaces:

Serializable, Comparable<AreaClass>

public enum AreaClass
extends Enum<AreaClass>

Enumeration of valid area classes.

See Also:

"XSL-FO 1.1, Section 4.2.5."

Enum Constant Summary

XSL_ABSOLUTE
The area is absolutely positioned, and will be placed by the FO generating the relevant reference-area.

XSL_ANCHOR
The area is an anchor area, is placed arbitrarily, and does not affect stacking.

XSL_BEFORE_FLOAT
The area is inside a before-float, and will be placed by the ancestor page-sequence, but is stackable.

XSL_FIXED
The area is in a fixed location, and will be placed by the ancestor page-sequence.

XSL_FOOTNOTE
The area is inside a footnote, and will be placed by the ancestor page-sequence, but is stackable.

XSL_NORMAL
The area is stacked with other areas in sequence.

XSL_SIDE_FLOAT
The area is part of a side-float, and will be placed by the FO generating the relevant reference-area.

Method Summary

protected boolean	isAnchor() Indicates whether the Area is an anchor area.
protected boolean	isNormal() Indicates whether the Area is a normal area.
protected boolean	isPageLevelOutOfLine() Indicates whether the Area is a page-level-out-of-line area.
protected boolean	isReferenceLevelOutOfLine() Indicates whether the Area is a reference-level-out-of-line area.
protected boolean	isStackable() Indicates whether the Area is stackable.
static AreaClass	valueOf(String name) Returns the enum constant of this type with the specified name.
static AreaClass[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XSL_NORMAL

public static final AreaClass XSL_NORMAL

The area is stacked with other areas in sequence.

XSL_FOOTNOTE

public static final AreaClass XSL_FOOTNOTE

The area is inside a footnote, and will be placed by the ancestor page-sequence, but is stackable.

XSL_BEFORE_FLOAT

public static final AreaClass XSL_BEFORE_FLOAT

The area is inside a before-float, and will be placed by the ancestor page-sequence, but is stackable.

XSL_FIXED

public static final AreaClass XSL_FIXED

The area is in a fixed location, and will be placed by the ancestor page-sequence. It is not stackable.

XSL_SIDE_FLOAT

public static final AreaClass XSL_SIDE_FLOAT

The area is part of a side-float, and will be placed by the FO generating the relevant reference-area.

XSL_ABSOLUTE

public static final AreaClass XSL_ABSOLUTE

The area is absolutely positioned, and will be placed by the FO generating the relevant reference-area.

XSL_ANCHOR

public static final AreaClass XSL_ANCHOR

The area is an anchor area, is placed arbitrarily, and does not affect stacking.

Method Detail

values

public static AreaClass[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AreaClass c : AreaClass.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AreaClass valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isAnchor

protected boolean isAnchor()

Indicates whether the Area is an anchor area.

Returns:

True iff the Area is an anchor area.

isNormal

protected boolean isNormal()

Indicates whether the Area is a normal area.

Returns:

True iff the Area is a normal area.

isPageLevelOutOfLine

protected boolean isPageLevelOutOfLine()

Indicates whether the Area is a page-level-out-of-line area.

Returns:

True iff the Area is a page-level-out-of-line area.

isReferenceLevelOutOfLine

protected boolean isReferenceLevelOutOfLine()

Indicates whether the Area is a reference-level-out-of-line area.

Returns:

True iff the Area is a reference-level-out-of-line area.

isStackable

protected boolean isStackable()

Indicates whether the Area is stackable.

Returns:

True iff the Area is stackable.