Collation (JavaFX 17)

Module javafx.graphics
Package javafx.print

## Enum Collation

- java.lang.Object
- - java.lang.Enum<Collation>
  - - javafx.print.Collation

- All Implemented Interfaces:
    `Serializable`, `Comparable<Collation>`

      public enum Collation
      extends Enum<Collation>

  Collation specifies whether or not media sheets of each copy of a printed document in a job are to be in sequence. It has no effect or relevance unless multiple job copies are printed.
  Since:
    JavaFX 8.0

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `COLLATED` | Each copy of a document is printed together.
    `UNCOLLATED` | The same numbered pages are consecutive in the output, For example: 2 copies of a document with 2 pages is printed : Page 1, Page 1, Page 2, Page 2.

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Collation` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
    `static Collation[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods declared in class java.lang.Enum

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

    - ### Methods declared in class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### UNCOLLATED

          public static final Collation UNCOLLATED

      The same numbered pages are consecutive in the output, For example: 2 copies of a document with 2 pages is printed : Page 1, Page 1, Page 2, Page 2.

    - #### COLLATED

          public static final Collation COLLATED

      Each copy of a document is printed together. FOr example: 2 copies of a document with 2 pages is printed : Page 1, Page 2, Page 1, Page 2.

  - ### Method Detail

    - #### values

          public static Collation[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (Collation c : Collation.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static Collation 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