com.smartgwt.client.types

## Enum FormattingContext

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

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

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

  The context for which a data-value is being formatted.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `HOVER` for transient display in a hover
    `STATIC` for static display in the chart body

  - ### Method Summary

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

    - #### STATIC

          public static final FormattingContext STATIC

      for static display in the chart body

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

    - #### HOVER

          public static final FormattingContext HOVER

      for transient display in a hover

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

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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