Top Description Fields Constructors Methods

org.apache.pdfbox.pdmodel

public final Enum PageLayout

Class Inheritance

extends Enum<PageLayout>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.pdmodel.PageLayout

Imports

org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences

A name object specifying the page layout shall be used when the document is opened.

Author: John Hewson

Field Summary

Modifier and Type	Field and Description
public static final PageLayout	ONE_COLUMN Display the pages in one column.
public static final PageLayout	SINGLE_PAGE Display one page at a time.
public static final PageLayout	TWO_COLUMN_LEFT Display the pages in two columns), with odd numbered pages on the left.
public static final PageLayout	TWO_COLUMN_RIGHT Display the pages in two columns), with odd numbered pages on the right.
public static final PageLayout	TWO_PAGE_LEFT Display the pages two at a time), with odd-numbered pages on the left.
public static final PageLayout	TWO_PAGE_RIGHT Display the pages two at a time), with odd-numbered pages on the right.
private final String	value

Constructor Summary

Access	Constructor and Description
private	PageLayout(String value)

Method Summary

Modifier and Type	Method and Description
public static PageLayout	fromString(String value)
public String	Returns: the string value stringValue() Returns the string value, as used in a PDF file.
public static PageLayout	valueOf(String name)
public static PageLayout[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ONE_COLUMN	back to summary
public static final PageLayout ONE_COLUMN Display the pages in one column.

SINGLE_PAGE	back to summary
public static final PageLayout SINGLE_PAGE Display one page at a time.

TWO_COLUMN_LEFT	back to summary
public static final PageLayout TWO_COLUMN_LEFT Display the pages in two columns), with odd numbered pages on the left.

TWO_COLUMN_RIGHT	back to summary
public static final PageLayout TWO_COLUMN_RIGHT Display the pages in two columns), with odd numbered pages on the right. See also `PDViewerPreferences.setReadingDirection()` if dealing with RTL language.

TWO_PAGE_LEFT	back to summary
public static final PageLayout TWO_PAGE_LEFT Display the pages two at a time), with odd-numbered pages on the left.

TWO_PAGE_RIGHT	back to summary
public static final PageLayout TWO_PAGE_RIGHT Display the pages two at a time), with odd-numbered pages on the right. See also `PDViewerPreferences.setReadingDirection()` if dealing with RTL language.

value	back to summary
private final String value

Constructor Detail

PageLayout	back to summary
private PageLayout(String value)

Method Detail

fromString	back to summary
public static PageLayout fromString(String value)

stringValue

back to summary

public String stringValue()

Returns the string value, as used in a PDF file.

Returns:String: the string value

valueOf	back to summary
public static PageLayout valueOf(String name)

values	back to summary
public static PageLayout[] values()