Package com.selectpdf

Enum ApiEnums.PageLayout

java.lang.Object
java.lang.Enum<ApiEnums.PageLayout>
com.selectpdf.ApiEnums.PageLayout
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ApiEnums.PageLayout>, java.lang.constant.Constable
Enclosing class:
ApiEnums
public static enum ApiEnums.PageLayout
extends java.lang.Enum<ApiEnums.PageLayout>
The page layout to be used when the pdf document is opened in a viewer.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    OneColumn
    Displays the pages in one column.
    SinglePage
    Displays one page at a time.
    TwoColumnLeft
    Displays the pages in two columns, with odd-numbered pages on the left.
    TwoColumnRight
    Displays the pages in two columns, with odd-numbered pages on the right.

  • Method Summary

    Modifier and Type Method Description
    static ApiEnums.PageLayout valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static ApiEnums.PageLayout[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static ApiEnums.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 ApiEnums.PageLayout valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null