Package org.jpedal.constants

Enum Class PageLayout

java.lang.Object

java.lang.Enum<PageLayout>

org.jpedal.constants.PageLayout

All Implemented Interfaces:

Serializable, Comparable<PageLayout>, Constable

public enum PageLayout
extends Enum<PageLayout>

PageLayout constants define the layout to be used when a PDF document is opened.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ONE_COLUMN	Display the pages in one column.
SINGLE_PAGE	Display one page at a time.
TWO_COLUMN_LEFT	Display the pages in two columns, with odd-numbered pages on the left.
TWO_COLUMN_RIGHT	Display the pages in two columns, with odd-numbered pages on the right.
TWO_PAGE_LEFT	(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left.
TWO_PAGE_RIGHT	(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINGLE_PAGE

public static final PageLayout SINGLE_PAGE

Display one page at a time.

This value is the default.

ONE_COLUMN

public static final PageLayout ONE_COLUMN

Display the pages in one column.

TWO_COLUMN_LEFT

public static final PageLayout TWO_COLUMN_LEFT

Display the pages in two columns, with odd-numbered pages on the left.

TWO_COLUMN_RIGHT

public static final PageLayout TWO_COLUMN_RIGHT

Display the pages in two columns, with odd-numbered pages on the right.

TWO_PAGE_LEFT

public static final PageLayout TWO_PAGE_LEFT

(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left.

TWO_PAGE_RIGHT

public static final PageLayout TWO_PAGE_RIGHT

(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right.

Method Details

values

public static PageLayout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PageLayout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getLayout

public String getLayout()

Returns the String value associated with this enum instance..

Returns:

the String value associated with this enum instance.