Package org.jpedal.constants

Enum Class PageMode

java.lang.Object

java.lang.Enum<PageMode>

org.jpedal.constants.PageMode

All Implemented Interfaces:

Serializable, Comparable<PageMode>, Constable

public enum PageMode
extends Enum<PageMode>

PageMode constants define how a PDF document shall be displayed when opened.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL_SCREEN	Full-screen mode, with no menu bar, window controls, or any other window visible.
USE_ATTACHMENTS	(PDF 1.6) Attachments panel visible.
USE_NONE	Neither document outline nor thumbnail images visible.
USE_OC	(PDF 1.5) Optional content group panel visible.
USE_OUTLINES	Document outline visible.
USE_THUMBS	Thumbnail images visible.

Method Summary

Modifier and Type	Method	Description
String	getMode()	Returns the String value associated with this enum instance..
static PageMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PageMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USE_NONE

public static final PageMode USE_NONE

Neither document outline nor thumbnail images visible.

This is the default value.

USE_OUTLINES

public static final PageMode USE_OUTLINES

Document outline visible.

USE_THUMBS

public static final PageMode USE_THUMBS

Thumbnail images visible.

FULL_SCREEN

public static final PageMode FULL_SCREEN

Full-screen mode, with no menu bar, window controls, or any other window visible.

USE_OC

public static final PageMode USE_OC

(PDF 1.5) Optional content group panel visible.

USE_ATTACHMENTS

public static final PageMode USE_ATTACHMENTS

(PDF 1.6) Attachments panel visible.

Method Details

values

public static PageMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PageMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMode

public String getMode()

Returns the String value associated with this enum instance..

Returns:

the String value associated with this enum instance.