org.sejda.model.pdf.viewerpreference

Enum PdfPageLayout

java.lang.Object

java.lang.Enum<PdfPageLayout>

org.sejda.model.pdf.viewerpreference.PdfPageLayout

All Implemented Interfaces:

Serializable, Comparable<PdfPageLayout>, FriendlyNamed, MinRequiredVersion

public enum PdfPageLayout
extends Enum<PdfPageLayout>
implements MinRequiredVersion, FriendlyNamed

Possible values for the page layout to be used when the document is opened.
Pdf reference 1.7, TABLE 3.25 Entries in the catalog dictionary

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_COLUMN
SINGLE_PAGE
TWO_COLUMN_LEFT
TWO_COLUMN_RIGHT
TWO_PAGE_LEFT
TWO_PAGE_RIGHT

Method Summary

Methods

Modifier and Type	Method and Description
String	getFriendlyName()
PdfVersion	getMinVersion()
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

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

SINGLE_PAGE

public static final PdfPageLayout SINGLE_PAGE

ONE_COLUMN

public static final PdfPageLayout ONE_COLUMN

TWO_COLUMN_LEFT

public static final PdfPageLayout TWO_COLUMN_LEFT

TWO_COLUMN_RIGHT

public static final PdfPageLayout TWO_COLUMN_RIGHT

TWO_PAGE_LEFT

public static final PdfPageLayout TWO_PAGE_LEFT

TWO_PAGE_RIGHT

public static final PdfPageLayout TWO_PAGE_RIGHT

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

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FriendlyNamed

Returns:

the friendly name of the entity, to be usually used as a representation for an user.

getMinVersion

public PdfVersion getMinVersion()

Specified by:

getMinVersion in interface MinRequiredVersion

Returns:

the minimum required version