Package org.apache.pdfbox.pdmodel
Enum Class PageLayout
- All Implemented Interfaces:
Serializable
,Comparable<PageLayout>
,Constable
A name object specifying the page layout shall be used when the document is opened.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDisplay the pages in one column.Display one page at a time.Display the pages in two columns), with odd numbered pages on the left.Display the pages in two columns), with odd numbered pages on the right.Display the pages two at a time), with odd-numbered pages on the left.Display the pages two at a time), with odd-numbered pages on the right. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PageLayout
fromString
(String value) Returns the string value, as used in a PDF file.static PageLayout
Returns the enum constant of this class with the specified name.static PageLayout[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SINGLE_PAGE
Display one page at a time. -
ONE_COLUMN
Display the pages in one column. -
TWO_COLUMN_LEFT
Display the pages in two columns), with odd numbered pages on the left. -
TWO_COLUMN_RIGHT
Display the pages in two columns), with odd numbered pages on the right. See alsoPDViewerPreferences.setReadingDirection()
if dealing with RTL language. -
TWO_PAGE_LEFT
Display the pages two at a time), with odd-numbered pages on the left. -
TWO_PAGE_RIGHT
Display the pages two at a time), with odd-numbered pages on the right. See alsoPDViewerPreferences.setReadingDirection()
if dealing with RTL language.
-
-
Field Details
-
value
-
-
Constructor Details
-
PageLayout
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
fromString
-
stringValue
Returns the string value, as used in a PDF file.
-