com.gnostice.documents.pdf

Enum PDFPageLayout

java.lang.Object

java.lang.Enum<PDFPageLayout>

com.gnostice.documents.pdf.PDFPageLayout

All Implemented Interfaces:

Serializable, Comparable<PDFPageLayout>

public enum PDFPageLayout
extends Enum<PDFPageLayout>

This interface defines constants for specifying page layout to be used when document is displayed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_COLUMN Constant for displaying pages in a single column.
SINGLE_PAGE Constant for displaying one page at a time.
TWO_COLUMN_LEFT Constant for displaying pages in two columns, with odd-numbered pages on the left-side column.
TWO_COLUMN_RIGHT Constant for displaying pages in two columns, with odd-numbered pages on the right-side column.
TWO_PAGE_LEFT Constant for displaying two pages at a time, with odd-numbered pages on the left.
TWO_PAGE_RIGHT Constant for displaying two pages at a time, with odd-numbered pages on the right.

Method Summary

Modifier and Type	Method and Description
static PDFPageLayout	valueOf(String name) Returns the enum constant of this type with the specified name.
static PDFPageLayout[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SINGLE_PAGE

public static final PDFPageLayout SINGLE_PAGE

Constant for displaying one page at a time.

ONE_COLUMN

public static final PDFPageLayout ONE_COLUMN

Constant for displaying pages in a single column.

TWO_COLUMN_LEFT

public static final PDFPageLayout TWO_COLUMN_LEFT

Constant for displaying pages in two columns, with odd-numbered pages on the left-side column.

TWO_COLUMN_RIGHT

public static final PDFPageLayout TWO_COLUMN_RIGHT

Constant for displaying pages in two columns, with odd-numbered pages on the right-side column.

TWO_PAGE_LEFT

public static final PDFPageLayout TWO_PAGE_LEFT

Constant for displaying two pages at a time, with odd-numbered pages on the left. Applicable to PDF version 1.5.

TWO_PAGE_RIGHT

public static final PDFPageLayout TWO_PAGE_RIGHT

Constant for displaying two pages at a time, with odd-numbered pages on the right. Applicable to PDF version 1.5.

Method Detail

values

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

Returns:

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

valueOf

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