org.foray.pioneer
Enum Status

java.lang.Object
  java.lang.Enum<Status>
      org.foray.pioneer.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>

Enumeration of the possible Pioneer Layout status of an FO.

Enum Constant Summary

AREA_FULL_NONE
The status is that the area is full, and no layout was accomplished.

AREA_FULL_SOME
The status is that the area is full, but that some layout was accomplished.

FORCE_COLUMN_BREAK
The status is that we are at a forced column break.

FORCE_PAGE_BREAK
The status is that we are at a forced page break.

FORCE_PAGE_BREAK_EVEN
The status is that we are at a forced page break, and the next page must be even.

FORCE_PAGE_BREAK_ODD
The status is that we are at a forced page break, and the next page must be odd.

KEEP_WITH_NEXT
The status is that the current content must be kept with the next content.

OK
The status is "OK" or complete.

UNKNOWN
The status is "Unknown".

Method Summary

static Status	checkBreakAfter(org.axsl.common.value.Break breakAfter) Converts a given "break-after" value to the appropriate Status.
boolean	isIncomplete() Indicates whether this instance means that layout is incomplete.
boolean	isPageBreak() Indicates whether this instance means that a page break is required.
boolean	laidOutNone() Indicates whether this instance means that no layout has been accomplished.
static Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static Status[]	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

UNKNOWN

public static final Status UNKNOWN

The status is "Unknown".

OK

public static final Status OK

The status is "OK" or complete.

AREA_FULL_NONE

public static final Status AREA_FULL_NONE

The status is that the area is full, and no layout was accomplished.

AREA_FULL_SOME

public static final Status AREA_FULL_SOME

The status is that the area is full, but that some layout was accomplished.

FORCE_PAGE_BREAK

public static final Status FORCE_PAGE_BREAK

The status is that we are at a forced page break.

FORCE_PAGE_BREAK_EVEN

public static final Status FORCE_PAGE_BREAK_EVEN

The status is that we are at a forced page break, and the next page must be even.

FORCE_PAGE_BREAK_ODD

public static final Status FORCE_PAGE_BREAK_ODD

The status is that we are at a forced page break, and the next page must be odd.

FORCE_COLUMN_BREAK

public static final Status FORCE_COLUMN_BREAK

The status is that we are at a forced column break.

KEEP_WITH_NEXT

public static final Status KEEP_WITH_NEXT

The status is that the current content must be kept with the next content.

Method Detail

values

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

Returns:

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

valueOf

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

isIncomplete

public boolean isIncomplete()

Indicates whether this instance means that layout is incomplete.

Returns:

True iff this status indicates that layout is incomplete.

laidOutNone

public boolean laidOutNone()

Indicates whether this instance means that no layout has been accomplished.

Returns:

True iff this status indicates that no layout has been accomplished.

isPageBreak

public boolean isPageBreak()

Indicates whether this instance means that a page break is required.

Returns:

True this status indicates that a page break is required.

checkBreakAfter

public static Status checkBreakAfter(org.axsl.common.value.Break breakAfter)

Converts a given "break-after" value to the appropriate Status.

Parameters:

breakAfter - The "break-after" constant.

Returns:

The Status matching breakAfter.