com.gnostice.documents.pdf

Enum PDFPageMode

java.lang.Object

java.lang.Enum<PDFPageMode>

com.gnostice.documents.pdf.PDFPageMode

All Implemented Interfaces:

Serializable, Comparable<PDFPageMode>

public enum PDFPageMode
extends Enum<PDFPageMode>

This interface defines constants for specifying how document should be displayed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULLSCREEN Constant to display document in fullscreen mode.
USEATTACHMENTS Constant to display Attachments panel.
USENONE Constant to prevent display of document outline and thumbnail images.
USEOC Constant to display option content group panel.
USEOUTLINES Constant to display document outline.
USETHUMBS Constant to display thumnail images.

Method Summary

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

USENONE

public static final PDFPageMode USENONE

Constant to prevent display of document outline and thumbnail images.

USEOUTLINES

public static final PDFPageMode USEOUTLINES

Constant to display document outline.

USETHUMBS

public static final PDFPageMode USETHUMBS

Constant to display thumnail images.

FULLSCREEN

public static final PDFPageMode FULLSCREEN

Constant to display document in fullscreen mode.

USEOC

public static final PDFPageMode USEOC

Constant to display option content group panel.

USEATTACHMENTS

public static final PDFPageMode USEATTACHMENTS

Constant to display Attachments panel.

Method Detail

values

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

Returns:

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

valueOf

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