Package com.smartgwt.client.types

# Enum FormattingContext

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

All Implemented Interfaces:
  `ValueEnum`, `Serializable`, `Comparable<FormattingContext>`, `Constable`

public enum FormattingContext extends Enum<FormattingContext> implements ValueEnum
The context for which a data-value is being formatted.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

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

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getValue()`
  `static FormattingContext`
  `valueOf(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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

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

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

- ## Enum Constant Details

  - ### 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 Details

  - ### values

    public static FormattingContext[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
      an array containing the constants of this enum type, in the order they are declared

  - ### valueOf

    public static FormattingContext valueOf(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:
      `IllegalArgumentException` - if this enum type has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### getValue

    public String getValue()
    Specified by:
      `getValue` in interface `ValueEnum`