Package io.deephaven.query.parameterized

Enum Class DisplayType

java.lang.Object
java.lang.Enum<DisplayType>
io.deephaven.query.parameterized.DisplayType
All Implemented Interfaces:
Serializable, Comparable<DisplayType>, java.lang.constant.Constable
public enum DisplayType extends Enum<DisplayType>

This enum represents the various display types supported by the Parameterized Query library. Front ends will make a best effort attempt to render the parameters of the query as the requested display type. If, for some reason the front end can't display the parameter as the requested type it will fall back to Text.

Note that parameters will be validated against their Constraints regardless of the used display type.

  • Enum Constant Details

    • Text

      public static final DisplayType Text
      A simple text entry box

    • FixedList

      public static final DisplayType FixedList
      A fixed List that allows one or more items to be selected

    • EditableList

      public static final DisplayType EditableList
      A list of items that allows users to add or remove items.

    • CheckBox

      public static final DisplayType CheckBox
      An on/off checkbox

    • DatePicker

      public static final DisplayType DatePicker
      A Control to pick a single String formatted Date in YYYY-mm-dd

    • DateTimePicker

      public static final DisplayType DateTimePicker
      A Control to pick a date and time formatted in nanos since epoch

    • DeephavenTable

      public static final DisplayType DeephavenTable
      A parameter that displays it's values from a deephaven table

  • Method Details

    • values

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