org.foray.fotree.fo
Enum FoObject

java.lang.Object
  java.lang.Enum<FoObject>
      org.foray.fotree.fo.FoObject

All Implemented Interfaces:

Serializable, Comparable<FoObject>

public enum FoObject
extends Enum<FoObject>

An enumeration for XSL-FO objects.

Enum Constant Summary

BASIC_LINK
Constant indicating a "basic-link" FO.

BIDI_OVERRIDE
Constant indicating a "bidi-override" FO.

BLOCK
Constant indicating a "block" FO.

BLOCK_CONTAINER
Constant indicating a "block-container" FO.

BOOKMARK
Constant indicating a "bookmark" FO.

BOOKMARK_TITLE
Constant indicating a "bookmark-title" FO.

BOOKMARK_TREE
Constant indicating a "bookmark-tree" FO.

CHANGE_BAR_BEGIN
Constant indicating a "change-bar-begin" FO.

CHANGE_BAR_END
Constant indicating a "change-bar-end" FO.

CHARACTER
Constant indicating a "character" FO.

COLOR_PROFILE
Constant indicating a "color-profile" FO.

CONDITIONAL_PAGE_MASTER_REFERENCE
Constant indicating a "conditional-page-master-reference" FO.

DECLARATIONS
Constant indicating a "declarations" FO.

EXTERNAL_GRAPHIC
Constant indicating an "external-graphic" FO.

FLOAT
Constant indicating a "float" FO.

FLOW
Constant indicating a "flow" FO.

FLOW_ASSIGNMENT
Constant indicating a "flow-assignment" FO.

FLOW_MAP
Constant indicating a "flow-map" FO.

FLOW_NAME_SPECIFIER
Constant indicating a "flow-name-specifier" FO.

FLOW_SOURCE_LIST
Constant indicating a "flow-source-list" FO.

FLOW_TARGET_LIST
Constant indicating a "flow-target-list" FO.

FOLIO_PREFIX
Constant indicating a "folio-prefix" FO.

FOLIO_SUFFIX
Constant indicating a "folio-suffix" FO.

FOOTNOTE
Constant indicating a "footnote" FO.

FOOTNOTE_BODY
Constant indicating a "footnote-body" FO.

INDEX_KEY_REFERENCE
Constant indicating an "index-key-reference" FO.

INDEX_PAGE_CITATION_LIST
Constant indicating an "index-page-citation-list" FO.

INDEX_PAGE_CITATION_LIST_SEPARATOR
Constant indicating an "index-page-citation-list-separator" FO.

INDEX_PAGE_CITATION_RANGE_SEPARATOR
Constant indicating an "index-page-citation-range-separator" FO.

INDEX_PAGE_NUMBER_PREFIX
Constant indicating an "index-page-number-prefix" FO.

INDEX_PAGE_NUMBER_SUFFIX
Constant indicating an "index-page-number-suffix" FO.

INDEX_RANGE_BEGIN
Constant indicating an "index-range-begin" FO.

INDEX_RANGE_END
Constant indicating an "index-range-end" FO.

INITIAL_PROPERTY_SET
Constant indicating an "initial-property-set" FO.

INLINE
Constant indicating an "inline" FO.

INLINE_CONTAINER
Constant indicating an "inline-container" FO.

INSTREAM_FOREIGN_OBJECT
Constant indicating an "instream-foreign-object" FO.

LAYOUT_MASTER_SET
Constant indicating a "layout-master-set" FO.

LEADER
Constant indicating a "leader" FO.

LIST_BLOCK
Constant indicating a "list-block" FO.

LIST_ITEM
Constant indicating a "list-item" FO.

LIST_ITEM_BODY
Constant indicating a "list-item-body".

LIST_ITEM_LABEL
Constant indicating a "list-item-label" FO.

MARKER
Constant indicating a "marker" FO.

MULTI_CASE
Constant indicating a "multi-case" FO.

MULTI_PROPERTIES
Constant indicating a "multi-properties" FO.

MULTI_PROPERTY_SET
Constant indicating a "multi-property-set" FO.

MULTI_SWITCH
Constant indicating a "multi-switch" FO.

MULTI_TOGGLE
Constant indicating a "multi-toggle" FO.

PAGE_NUMBER
Constant indicating a "page-number" FO.

PAGE_NUMBER_CITATION
Constant indicating a "page-number-citation" FO.

PAGE_NUMBER_CITATION_LAST
Constant indicating a "page-number-citation-last" FO.

PAGE_SEQUENCE
Constant indicating a "page-sequence" FO.

PAGE_SEQUENCE_MASTER
Constant indicating a "page-sequence-master" FO.

PAGE_SEQUENCE_WRAPPER
Constant indicating a "page-sequence-wrapper" FO.

REGION_AFTER
Constant indicating a "region-after" FO.

REGION_BEFORE
Constant indicating a "region-before" FO.

REGION_BODY
Constant indicating a "region-body" FO.

REGION_END
Constant indicating a "region-end" FO.

REGION_NAME_SPECIFIER
Constant indicating a "region-name-specifier" FO.

REGION_START
Constant indicating a "region-start" FO.

REPEATABLE_PAGE_MASTER_ALTERNATIVES
Constant indicating a "repeatable-page-master-alternatives" FO.

REPEATABLE_PAGE_MASTER_REFERENCE
Constant indicating a "repeatable-page-master-reference" FO.

RETRIEVE_MARKER
Constant indicating a "retrieve-marker" FO.

RETRIEVE_TABLE_MARKER
Constant indicating a "retrieve-table-marker" FO.

ROOT
Constant indicating a "root" FO.

SCALING_VALUE_CITATION
Constant indicating a "scaling-value-citation" FO.

SIMPLE_PAGE_MASTER
Constant indicating a "simple-page-master".

SINGLE_PAGE_MASTER_REFERENCE
Constant indicating a "single-page-master-reference" FO.

STATIC_CONTENT
Constant indicating a "static-content" FO.

TABLE
Constant indicating a "table" FO.

TABLE_AND_CAPTION
Constant indicating a "table-and-caption" FO.

TABLE_BODY
Constant indicating a "table-body" FO.

TABLE_CAPTION
Constant indicating a "table-caption" FO.

TABLE_CELL
Constant indicating a "table-cell" FO.

TABLE_COLUMN
Constant indicating a "table-column" FO.

TABLE_FOOTER
Constant indicating a "table-footer" FO.

TABLE_HEADER
Constant indicating a "table-header" FO.

TABLE_ROW
Constant indicating a "table-row" FO.

TITLE
Constant indicating a "title" FO.

WRAPPER
Constant indicating a "wrapper" FO.

Method Summary

String	toXslFo() Converts an object name enumeration to its XSL-FO name.
static FoObject	valueOf(String name) Returns the enum constant of this type with the specified name.
static FoObject[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static FoObject	xslValueOf(String xslName) Similar to the Java 1.5 Enum valueOf(String) method, but operates on the XSL-FO name of the object instead of its enumerated name.

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

BASIC_LINK

public static final FoObject BASIC_LINK

Constant indicating a "basic-link" FO.

BIDI_OVERRIDE

public static final FoObject BIDI_OVERRIDE

Constant indicating a "bidi-override" FO.

BLOCK

public static final FoObject BLOCK

Constant indicating a "block" FO.

BLOCK_CONTAINER

public static final FoObject BLOCK_CONTAINER

Constant indicating a "block-container" FO.

BOOKMARK

public static final FoObject BOOKMARK

Constant indicating a "bookmark" FO.

BOOKMARK_TITLE

public static final FoObject BOOKMARK_TITLE

Constant indicating a "bookmark-title" FO.

BOOKMARK_TREE

public static final FoObject BOOKMARK_TREE

Constant indicating a "bookmark-tree" FO.

CHANGE_BAR_BEGIN

public static final FoObject CHANGE_BAR_BEGIN

Constant indicating a "change-bar-begin" FO.

CHANGE_BAR_END

public static final FoObject CHANGE_BAR_END

Constant indicating a "change-bar-end" FO.

CHARACTER

public static final FoObject CHARACTER

Constant indicating a "character" FO.

COLOR_PROFILE

public static final FoObject COLOR_PROFILE

Constant indicating a "color-profile" FO.

CONDITIONAL_PAGE_MASTER_REFERENCE

public static final FoObject CONDITIONAL_PAGE_MASTER_REFERENCE

Constant indicating a "conditional-page-master-reference" FO.

DECLARATIONS

public static final FoObject DECLARATIONS

Constant indicating a "declarations" FO.

EXTERNAL_GRAPHIC

public static final FoObject EXTERNAL_GRAPHIC

Constant indicating an "external-graphic" FO.

FLOAT

public static final FoObject FLOAT

Constant indicating a "float" FO.

FLOW

public static final FoObject FLOW

Constant indicating a "flow" FO.

FLOW_ASSIGNMENT

public static final FoObject FLOW_ASSIGNMENT

Constant indicating a "flow-assignment" FO.

FLOW_MAP

public static final FoObject FLOW_MAP

Constant indicating a "flow-map" FO.

FLOW_NAME_SPECIFIER

public static final FoObject FLOW_NAME_SPECIFIER

Constant indicating a "flow-name-specifier" FO.

FLOW_SOURCE_LIST

public static final FoObject FLOW_SOURCE_LIST

Constant indicating a "flow-source-list" FO.

FLOW_TARGET_LIST

public static final FoObject FLOW_TARGET_LIST

Constant indicating a "flow-target-list" FO.

FOLIO_PREFIX

public static final FoObject FOLIO_PREFIX

Constant indicating a "folio-prefix" FO.

FOLIO_SUFFIX

public static final FoObject FOLIO_SUFFIX

Constant indicating a "folio-suffix" FO.

FOOTNOTE

public static final FoObject FOOTNOTE

Constant indicating a "footnote" FO.

FOOTNOTE_BODY

public static final FoObject FOOTNOTE_BODY

Constant indicating a "footnote-body" FO.

INDEX_KEY_REFERENCE

public static final FoObject INDEX_KEY_REFERENCE

Constant indicating an "index-key-reference" FO.

INDEX_PAGE_CITATION_LIST

public static final FoObject INDEX_PAGE_CITATION_LIST

Constant indicating an "index-page-citation-list" FO.

INDEX_PAGE_CITATION_LIST_SEPARATOR

public static final FoObject INDEX_PAGE_CITATION_LIST_SEPARATOR

Constant indicating an "index-page-citation-list-separator" FO.

INDEX_PAGE_CITATION_RANGE_SEPARATOR

public static final FoObject INDEX_PAGE_CITATION_RANGE_SEPARATOR

Constant indicating an "index-page-citation-range-separator" FO.

INDEX_PAGE_NUMBER_PREFIX

public static final FoObject INDEX_PAGE_NUMBER_PREFIX

Constant indicating an "index-page-number-prefix" FO.

INDEX_PAGE_NUMBER_SUFFIX

public static final FoObject INDEX_PAGE_NUMBER_SUFFIX

Constant indicating an "index-page-number-suffix" FO.

INDEX_RANGE_BEGIN

public static final FoObject INDEX_RANGE_BEGIN

Constant indicating an "index-range-begin" FO.

INDEX_RANGE_END

public static final FoObject INDEX_RANGE_END

Constant indicating an "index-range-end" FO.

INITIAL_PROPERTY_SET

public static final FoObject INITIAL_PROPERTY_SET

Constant indicating an "initial-property-set" FO.

INLINE

public static final FoObject INLINE

Constant indicating an "inline" FO.

INLINE_CONTAINER

public static final FoObject INLINE_CONTAINER

Constant indicating an "inline-container" FO.

INSTREAM_FOREIGN_OBJECT

public static final FoObject INSTREAM_FOREIGN_OBJECT

Constant indicating an "instream-foreign-object" FO.

LAYOUT_MASTER_SET

public static final FoObject LAYOUT_MASTER_SET

Constant indicating a "layout-master-set" FO.

LEADER

public static final FoObject LEADER

Constant indicating a "leader" FO.

LIST_BLOCK

public static final FoObject LIST_BLOCK

Constant indicating a "list-block" FO.

LIST_ITEM

public static final FoObject LIST_ITEM

Constant indicating a "list-item" FO.

LIST_ITEM_BODY

public static final FoObject LIST_ITEM_BODY

Constant indicating a "list-item-body".

LIST_ITEM_LABEL

public static final FoObject LIST_ITEM_LABEL

Constant indicating a "list-item-label" FO.

MARKER

public static final FoObject MARKER

Constant indicating a "marker" FO.

MULTI_CASE

public static final FoObject MULTI_CASE

Constant indicating a "multi-case" FO.

MULTI_PROPERTIES

public static final FoObject MULTI_PROPERTIES

Constant indicating a "multi-properties" FO.

MULTI_PROPERTY_SET

public static final FoObject MULTI_PROPERTY_SET

Constant indicating a "multi-property-set" FO.

MULTI_SWITCH

public static final FoObject MULTI_SWITCH

Constant indicating a "multi-switch" FO.

MULTI_TOGGLE

public static final FoObject MULTI_TOGGLE

Constant indicating a "multi-toggle" FO.

PAGE_NUMBER

public static final FoObject PAGE_NUMBER

Constant indicating a "page-number" FO.

PAGE_NUMBER_CITATION

public static final FoObject PAGE_NUMBER_CITATION

Constant indicating a "page-number-citation" FO.

PAGE_NUMBER_CITATION_LAST

public static final FoObject PAGE_NUMBER_CITATION_LAST

Constant indicating a "page-number-citation-last" FO.

PAGE_SEQUENCE

public static final FoObject PAGE_SEQUENCE

Constant indicating a "page-sequence" FO.

PAGE_SEQUENCE_MASTER

public static final FoObject PAGE_SEQUENCE_MASTER

Constant indicating a "page-sequence-master" FO.

PAGE_SEQUENCE_WRAPPER

public static final FoObject PAGE_SEQUENCE_WRAPPER

Constant indicating a "page-sequence-wrapper" FO.

REGION_AFTER

public static final FoObject REGION_AFTER

Constant indicating a "region-after" FO.

REGION_BEFORE

public static final FoObject REGION_BEFORE

Constant indicating a "region-before" FO.

REGION_BODY

public static final FoObject REGION_BODY

Constant indicating a "region-body" FO.

REGION_END

public static final FoObject REGION_END

Constant indicating a "region-end" FO.

REGION_NAME_SPECIFIER

public static final FoObject REGION_NAME_SPECIFIER

Constant indicating a "region-name-specifier" FO.

REGION_START

public static final FoObject REGION_START

Constant indicating a "region-start" FO.

REPEATABLE_PAGE_MASTER_ALTERNATIVES

public static final FoObject REPEATABLE_PAGE_MASTER_ALTERNATIVES

Constant indicating a "repeatable-page-master-alternatives" FO.

REPEATABLE_PAGE_MASTER_REFERENCE

public static final FoObject REPEATABLE_PAGE_MASTER_REFERENCE

Constant indicating a "repeatable-page-master-reference" FO.

RETRIEVE_MARKER

public static final FoObject RETRIEVE_MARKER

Constant indicating a "retrieve-marker" FO.

RETRIEVE_TABLE_MARKER

public static final FoObject RETRIEVE_TABLE_MARKER

Constant indicating a "retrieve-table-marker" FO.

ROOT

public static final FoObject ROOT

Constant indicating a "root" FO.

SCALING_VALUE_CITATION

public static final FoObject SCALING_VALUE_CITATION

Constant indicating a "scaling-value-citation" FO.

SIMPLE_PAGE_MASTER

public static final FoObject SIMPLE_PAGE_MASTER

Constant indicating a "simple-page-master".

SINGLE_PAGE_MASTER_REFERENCE

public static final FoObject SINGLE_PAGE_MASTER_REFERENCE

Constant indicating a "single-page-master-reference" FO.

STATIC_CONTENT

public static final FoObject STATIC_CONTENT

Constant indicating a "static-content" FO.

TABLE

public static final FoObject TABLE

Constant indicating a "table" FO.

TABLE_AND_CAPTION

public static final FoObject TABLE_AND_CAPTION

Constant indicating a "table-and-caption" FO.

TABLE_BODY

public static final FoObject TABLE_BODY

Constant indicating a "table-body" FO.

TABLE_CAPTION

public static final FoObject TABLE_CAPTION

Constant indicating a "table-caption" FO.

TABLE_CELL

public static final FoObject TABLE_CELL

Constant indicating a "table-cell" FO.

TABLE_COLUMN

public static final FoObject TABLE_COLUMN

Constant indicating a "table-column" FO.

TABLE_FOOTER

public static final FoObject TABLE_FOOTER

Constant indicating a "table-footer" FO.

TABLE_HEADER

public static final FoObject TABLE_HEADER

Constant indicating a "table-header" FO.

TABLE_ROW

public static final FoObject TABLE_ROW

Constant indicating a "table-row" FO.

TITLE

public static final FoObject TITLE

Constant indicating a "title" FO.

WRAPPER

public static final FoObject WRAPPER

Constant indicating a "wrapper" FO.

Method Detail

values

public static FoObject[] 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 (FoObject c : FoObject.values())
    System.out.println(c);

Returns:

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

valueOf

public static FoObject 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

toXslFo

public String toXslFo()

Converts an object name enumeration to its XSL-FO name. For example, the enumeration TABLE_ROW converts to the XSL-FO name "table-row".

Returns:

The XSL-FO name for the object enumeration.

xslValueOf

public static FoObject xslValueOf(String xslName)

Similar to the Java 1.5 Enum valueOf(String) method, but operates on the XSL-FO name of the object instead of its enumerated name. For example, for the XSL-FO object "table-row", the enum is TABLE_ROW. The Java 1.5 Enum valueOf(String) method would operate on the enum name "TABLE_ROW". This method instead operates on "table-row".

Parameters:

xslName - The name of the XSL-FO object for which the enumerated value is needed.

Returns:

The enumerated value for xslName.