com.datalogics.PDFL

Enum PageMode

java.lang.Object

java.lang.Enum<PageMode>

com.datalogics.PDFL.PageMode

All Implemented Interfaces:

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

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

An enumerated data type used to describe the page view mode of a Document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTACHMENTS Display the Document with its attachments
BOOKMARKS Display the Document with the Bookmarks panel open (appears in the Document structure as "UseOutlines")
DOCUMENT_ONLY Display the Document without Bookmarks or Thumbnails (appears in the Document structure as "UseNone")
FULLSCREEN Display the Document in full-screen mode
NO_PREFERENCE Leave the PageMode as is (default for a new Document)
OPTIONAL_CONTENT Display the Document with the Layers panel open
THUMBNAILS Display the Document with the Thumbnails panel open

Method Summary

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

NO_PREFERENCE

public static final PageMode NO_PREFERENCE

Leave the PageMode as is (default for a new Document)

DOCUMENT_ONLY

public static final PageMode DOCUMENT_ONLY

Display the Document without Bookmarks or Thumbnails (appears in the Document structure as "UseNone")

BOOKMARKS

public static final PageMode BOOKMARKS

Display the Document with the Bookmarks panel open (appears in the Document structure as "UseOutlines")

THUMBNAILS

public static final PageMode THUMBNAILS

Display the Document with the Thumbnails panel open

FULLSCREEN

public static final PageMode FULLSCREEN

Display the Document in full-screen mode

OPTIONAL_CONTENT

public static final PageMode OPTIONAL_CONTENT

Display the Document with the Layers panel open

ATTACHMENTS

public static final PageMode ATTACHMENTS

Display the Document with its attachments

Method Detail

values

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

Returns:

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

valueOf

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