Enum PageLayout

java.lang.Object
java.lang.Enum<PageLayout>
org.apache.pdfbox.pdmodel.PageLayout
All Implemented Interfaces:
Serializable, Comparable<PageLayout>, java.lang.constant.Constable

public enum PageLayout extends Enum<PageLayout>
A name object specifying the page layout shall be used when the document is opened.
Author:
John Hewson
  • Enum Constant Details

    • SINGLE_PAGE

      public static final PageLayout SINGLE_PAGE
      Display one page at a time.
    • ONE_COLUMN

      public static final PageLayout ONE_COLUMN
      Display the pages in one column.
    • TWO_COLUMN_LEFT

      public static final PageLayout TWO_COLUMN_LEFT
      Display the pages in two columns), with odd numbered pages on the left.
    • TWO_COLUMN_RIGHT

      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

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

      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.
  • Method Details

    • values

      public static PageLayout[] 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

      public static PageLayout 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
    • fromString

      public static PageLayout fromString(String value)
    • stringValue

      public String stringValue()
      Returns the string value, as used in a PDF file.