Enum Class PaginatorMode

java.lang.Object
java.lang.Enum<PaginatorMode>
org.apache.myfaces.tobago.layout.PaginatorMode
All Implemented Interfaces:
Serializable, Comparable<PaginatorMode>, Constable

public enum PaginatorMode extends Enum<PaginatorMode>
Describes the mode of automatically displayed paginator.
Since:
5.15.0, 6.7.0
  • Enum Constant Details

    • auto

      public static final PaginatorMode auto
      A paginator is selected and displayed automatically. Will be the default in future versions.
    • custom

      public static final PaginatorMode custom
      If a paginator is desired, it must be specified on the page, e.g. with a <tc:paginatorList> inside of a <tc:paginatorPanel> tag.
    • list

      public static final PaginatorMode list
      The paginator is displayed as a list.
    • page

      public static final PaginatorMode page
      The page can be selected directly.
    • row

      public static final PaginatorMode row
      The row can be selected directly.
    • useShowAttributes

      @Deprecated(since="5.15.0, 6.7.0", forRemoval=true) public static final PaginatorMode useShowAttributes
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use auto if possible, or write a custom paginator.
      The show attributes of the sheet (e.g. showDirectLinks, showPageRange, showPageLinks, showRowCount) are used to display the paginator. This is the default, and emulates the old behavior.
  • Field Details

  • Method Details

    • values

      public static PaginatorMode[] 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 PaginatorMode 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
    • parse

      public static PaginatorMode parse(Object name) throws IllegalArgumentException
      Parameters:
      name - Name of the PaginatorMode.
      Throws:
      IllegalArgumentException - When the name doesn't match any PaginatorMode.