com.smartgwt.client.types

## Enum ControlName

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

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

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

  `ControlNames` are strings used to specify which UI controls should appear in the editor toolbar.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `ALIGNCENTER` A button to center the selected text
    `ALIGNLEFT` A button to left-align the selected text.
    `ALIGNRIGHT` A button to right-align the selected text.
    `BACKGROUNDCOLOR` A color picker allowing the user to set the text background color
    `BOLDSELECTION` A button to make the current selection bold.
    `COLOR` A color-picker allowing the user to set the text color
    `FONTSELECTOR` A select item allowing the user to change the font of the current text selection.
    `FONTSIZESELECTOR` A select item allowing the user to change the font size of the current text selection.
    `ITALICSELECTION` A button to make the current selection italic.
    `JUSTIFY` A button to justify the selected line of text.
    `UNDERLINESELECTION` A button to make the current selection underlined.

  - ### Method Summary

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

    - #### BOLDSELECTION

          public static final ControlName BOLDSELECTION

      A button to make the current selection bold.

    - #### ITALICSELECTION

          public static final ControlName ITALICSELECTION

      A button to make the current selection italic.

    - #### UNDERLINESELECTION

          public static final ControlName UNDERLINESELECTION

      A button to make the current selection underlined.

    - #### FONTSELECTOR

          public static final ControlName FONTSELECTOR

      A select item allowing the user to change the font of the current text selection.

    - #### FONTSIZESELECTOR

          public static final ControlName FONTSIZESELECTOR

      A select item allowing the user to change the font size of the current text selection.

    - #### ALIGNLEFT

          public static final ControlName ALIGNLEFT

      A button to left-align the selected text.

    - #### ALIGNRIGHT

          public static final ControlName ALIGNRIGHT

      A button to right-align the selected text.

    - #### ALIGNCENTER

          public static final ControlName ALIGNCENTER

      A button to center the selected text

    - #### JUSTIFY

          public static final ControlName JUSTIFY

      A button to justify the selected line of text.

    - #### COLOR

          public static final ControlName COLOR

      A color-picker allowing the user to set the text color

    - #### BACKGROUNDCOLOR

          public static final ControlName BACKGROUNDCOLOR

      A color picker allowing the user to set the text background color

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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