org.sejda.model.pdf.viewerpreference

Enum PdfPageMode

java.lang.Object

java.lang.Enum<PdfPageMode>

org.sejda.model.pdf.viewerpreference.PdfPageMode

All Implemented Interfaces:

Serializable, Comparable<PdfPageMode>, FriendlyNamed, MinRequiredVersion

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

Possible values to specify how the document should be displayed when 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
FULLSCREEN
USE_ATTACHMENTS
USE_NONE
USE_OC
USE_OUTLINES
USE_THUMBS

Method Summary

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

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

USE_NONE

public static final PdfPageMode USE_NONE

USE_OUTLINES

public static final PdfPageMode USE_OUTLINES

USE_THUMBS

public static final PdfPageMode USE_THUMBS

FULLSCREEN

public static final PdfPageMode FULLSCREEN

USE_OC

public static final PdfPageMode USE_OC

USE_ATTACHMENTS

public static final PdfPageMode USE_ATTACHMENTS

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

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