Enum Class PageMode

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

public enum PageMode extends Enum<PageMode>
A name object specifying how the document shall be displayed when opened.
  • Enum Constant Details

    • USE_NONE

      public static final PageMode USE_NONE
      Neither the outline nor the thumbnails are displayed.
    • USE_OUTLINES

      public static final PageMode USE_OUTLINES
      Show bookmarks when pdf is opened.
    • USE_THUMBS

      public static final PageMode USE_THUMBS
      Show thumbnails when pdf is opened.
    • FULL_SCREEN

      public static final PageMode FULL_SCREEN
      Full screen mode with no menu bar, window controls.
    • USE_OPTIONAL_CONTENT

      public static final PageMode USE_OPTIONAL_CONTENT
      Optional content group panel is visible when opened.
    • USE_ATTACHMENTS

      public static final PageMode USE_ATTACHMENTS
      Attachments panel is visible.
  • Field Details

    • value

      private final String value
  • Constructor Details

    • PageMode

      private PageMode(String value)
  • 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
    • fromString

      public static PageMode fromString(String value)
    • stringValue

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