com.smartgwt.client.types

## Enum FilteredSelectAllAction

- java.lang.Object
- - java.lang.Enum<FilteredSelectAllAction>
  - - com.smartgwt.client.types.FilteredSelectAllAction

- All Implemented Interfaces:
    ValueEnum, java.io.Serializable, java.lang.Comparable<FilteredSelectAllAction>

      public enum FilteredSelectAllAction
      extends java.lang.Enum<FilteredSelectAllAction>
      implements ValueEnum

  Governs how the `MultiPickerItem` "Select All" and "Deselect All" buttons should act when the user has filtered the set of visible options in the list.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `ALL` Ignore filtering: Always select or deselect the entire set of options including those not currently visible in the filtered list.
    `DISABLE` The buttons auto-disable when the list of options is filtered.
    `WHENLOADED` If the entire (filtered) list is loaded, both Select All and Clear are functional and will update the selection for all items in the filtered list.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getValue()`
    `static FilteredSelectAllAction` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static FilteredSelectAllAction[]` | `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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

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

- - ### Enum Constant Detail

    - #### DISABLE

          public static final FilteredSelectAllAction DISABLE

      The buttons auto-disable when the list of options is filtered.

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "disable".

    - #### ALL

          public static final FilteredSelectAllAction ALL

      Ignore filtering: Always select or deselect the entire set of options including those not currently visible in the filtered list. This option is only available if the entire set of data has been loaded in the client.

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "all".

    - #### WHENLOADED

          public static final FilteredSelectAllAction WHENLOADED

      If the entire (filtered) list is loaded, both Select All and Clear are functional and will update the selection for all items in the filtered list. If a partial list is loaded, these buttons will be disabled.

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "whenLoaded".

  - ### Method Detail

    - #### values

          public static FilteredSelectAllAction[] 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 (FilteredSelectAllAction c : FilteredSelectAllAction.values())
              System.out.println(c);

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

    - #### valueOf

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

    - #### getValue

          public java.lang.String getValue()

      Specified by:
        `getValue` in interface `ValueEnum`