org.axsl.common.value

Enum PageCitationStrategy

java.lang.Object

java.lang.Enum<PageCitationStrategy>

org.axsl.common.value.PageCitationStrategy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PageCitationStrategy>

public enum PageCitationStrategy
extends java.lang.Enum<PageCitationStrategy>

An enumeration of the possible page-citation-strategy values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The set of pages that might be cited includes the pages containing, as a descendant, any area that matches the "ref-id" trait of the formatting object on which this property appears plus any blank pages generated by the referenced formatting object.
NON_BLANK The set of pages that might be cited includes the pages containing, as a descendant, any area that matches the "ref-id" trait of the formatting object on which this property appears.
NORMAL The set of pages that might be cited includes the pages containing, as a descendant, any normal area that matches the "ref-id" trait of the formatting object on which this property appears, and which is either returned to that formatting object or is a descendant of a normal area returned to that formatting object.

Method Summary

Modifier and Type	Method and Description
static PageCitationStrategy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PageCitationStrategy[]	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

ALL

public static final PageCitationStrategy ALL

The set of pages that might be cited includes the pages containing, as a descendant, any area that matches the "ref-id" trait of the formatting object on which this property appears plus any blank pages generated by the referenced formatting object.

NORMAL

public static final PageCitationStrategy NORMAL

The set of pages that might be cited includes the pages containing, as a descendant, any normal area that matches the "ref-id" trait of the formatting object on which this property appears, and which is either returned to that formatting object or is a descendant of a normal area returned to that formatting object.

NON_BLANK

public static final PageCitationStrategy NON_BLANK

The set of pages that might be cited includes the pages containing, as a descendant, any area that matches the "ref-id" trait of the formatting object on which this property appears. This set of pages includes pages containing descendants out-of-line areas such as those generated by fo:footnote and fo:float.

Method Detail

values

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

Returns:

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

valueOf

public static PageCitationStrategy valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null