com.pdf_tools.fourheights.pdftoolbox.pdf.navigation

Enum PageLayout

java.lang.Object

java.lang.Enum<PageLayout>

com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.PageLayout

All Implemented Interfaces:

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

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

Specifies the horizontal arrangement for displaying pages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_PAGE Displays one page.
TWO_PAGE Displays two pages side by side.
TWO_PAGE_FIRST_PAGE_SINGLE Use ONE_PAGE display for the first page and TWO_PAGE display for the remaining pages.

Method Summary

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

ONE_PAGE

public static final PageLayout ONE_PAGE

Displays one page.

TWO_PAGE

public static final PageLayout TWO_PAGE

Displays two pages side by side.

TWO_PAGE_FIRST_PAGE_SINGLE

public static final PageLayout TWO_PAGE_FIRST_PAGE_SINGLE

Use ONE_PAGE display for the first page and TWO_PAGE display for the remaining pages.

Method Detail

values

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

Returns:

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

valueOf

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

fromValue

public static PageLayout fromValue(int value)

getValue

public int getValue()