Package org.apache.pdfbox.pdmodel
Enum PageMode
- All Implemented Interfaces:
Serializable
,Comparable<PageMode>
,java.lang.constant.Constable
A name object specifying how the 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 ConstantsEnum ConstantDescriptionFull screen mode with no menu bar, window controls.Attachments panel is visible.Neither the outline nor the thumbnails are displayed.Optional content group panel is visible when opened.Show bookmarks when pdf is opened.Show thumbnails when pdf is opened. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PageMode
fromString
(String value) Returns the string value, as used in a PDF file.static PageMode
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.
-
Enum Constant Details
-
USE_NONE
Neither the outline nor the thumbnails are displayed. -
USE_OUTLINES
Show bookmarks when pdf is opened. -
USE_THUMBS
Show thumbnails when pdf is opened. -
FULL_SCREEN
Full screen mode with no menu bar, window controls. -
USE_OPTIONAL_CONTENT
Optional content group panel is visible when opened. -
USE_ATTACHMENTS
Attachments panel is visible.
-
-
Field Details
-
value
-
-
Constructor Details
-
PageMode
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
fromString
-
stringValue
Returns the string value, as used in a PDF file.- Returns:
- the string value.
-