Package com.smartgwt.client.types

Enum ControlName

java.lang.Object
java.lang.Enum<ControlName>
com.smartgwt.client.types.ControlName
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<ControlName>, Constable
public enum ControlName extends Enum<ControlName> implements ValueEnum
Names for the standard controls built into the RichTextEditor. You can use these ControlNames in APIs like RichTextEditor.styleControls to control the order in which controls appear, to omit default controls or to show controls that are not shown by default.

Every ControlName is also the name of an com.smartgwt.client.types.AutoChild, so all the built-in controls can be skinned or otherwise customized via the AutoChild system. Note that the AutoChild name in each case is the camelCaps version of the ControlName value. For example, use "boldSelection" as the name of the AutoChild for the bold button, not "BOLDSELECTION".

  • Enum Constant Details

    • BOLDSELECTION

      public static final ControlName BOLDSELECTION
      A button to make the current selection bold.

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

    • ITALICSELECTION

      public static final ControlName ITALICSELECTION
      A button to make the current selection italic.

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

    • UNDERLINESELECTION

      public static final ControlName UNDERLINESELECTION
      A button to make the current selection underlined.

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

    • FONTSELECTOR

      public static final ControlName FONTSELECTOR
      A select item allowing the user to change the font of the current text selection.

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

    • FONTSIZESELECTOR

      public static final ControlName FONTSIZESELECTOR
      A select item allowing the user to change the font size of the current text selection.

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

    • ALIGNLEFT

      public static final ControlName ALIGNLEFT
      A button to left-align the selected text.

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

    • ALIGNRIGHT

      public static final ControlName ALIGNRIGHT
      A button to right-align the selected text.

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

    • ALIGNCENTER

      public static final ControlName ALIGNCENTER
      A button to center the selected text.

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

    • JUSTIFY

      public static final ControlName JUSTIFY
      A button to justify the selected line of text.

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

    • COLOR

      public static final ControlName COLOR
      A color-picker allowing the user to set the text color.

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

    • BACKGROUNDCOLOR

      public static final ControlName BACKGROUNDCOLOR
      A color picker allowing the user to set the text background color.

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

    • INDENT

      public static final ControlName INDENT
      Within text, indents the paragraph. Within a list, increases the list level.

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

    • OUTDENT

      public static final ControlName OUTDENT
      Within text, outdents the paragraph. Within a list, decreases the list level.

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

    • ORDEREDLIST

      public static final ControlName ORDEREDLIST
      Turns the current selection into an ordered list (HTML <ol>) or converts an unordered list to an ordered list.

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

    • UNORDEREDLIST

      public static final ControlName UNORDEREDLIST
      Turns the current selection into an unordered list (HTML <ul>) or converts an ordered list to an unordered list.

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

    • LISTPROPERTIES

      public static final ControlName LISTPROPERTIES
      Shows the listPropertiesDialog to allow configuring the options of the currently selected HTML list.

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

  • Method Details

    • values

      public static ControlName[] 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 ControlName 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