com.smartgwt.client.types

## Enum HoverMode

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

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

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

  When `canHover` and `showHoverComponents` are both true, HoverMode dictates the type of UI to be displayed when a user hovers over a row or cell.

  There are a number of builtin HoverModes and you can override `getCellHoverComponent()` to create your own hover behaviors.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `DETAIL_FIELD` Show a single field's value in an `HTMLFlow`.
    `DETAIL_RELATED` Show a `DetailViewer` displaying those fields from the record not already displayed in the grid, together with a separate `ListGrid` containing related-records.
    `DETAILS` Show a `DetailViewer` displaying those fields from the record which are not already displayed in the grid.
    `RELATED` Show a separate `ListGrid` containing related-records.

  - ### Method Summary

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

    - #### DETAIL_FIELD

          public static final HoverMode DETAIL_FIELD

      Show a single field's value in an `HTMLFlow`. Field to use is `ListGrid.detailField`.

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

    - #### DETAILS

          public static final HoverMode DETAILS

      Show a `DetailViewer` displaying those fields from the record which are not already displayed in the grid.

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

    - #### RELATED

          public static final HoverMode RELATED

      Show a separate `ListGrid` containing related-records. See `ListGridRecord.detailDS` and `ListGrid.recordDetailDSProperty` for more information.

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

    - #### DETAIL_RELATED

          public static final HoverMode DETAIL_RELATED

      Show a `DetailViewer` displaying those fields from the record not already displayed in the grid, together with a separate `ListGrid` containing related-records.

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

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

          public static HoverMode 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`