RichTextFeature (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- java.lang.Enum<RichTextFeature>
- - net.sf.mmm.client.ui.api.common.RichTextFeature

All Implemented Interfaces:

Serializable, Comparable<RichTextFeature>, NlsObject
```
public enum RichTextFeature
extends Enum<RichTextFeature>
implements NlsObject
```
The Enum with the available features of rich-text formatting options.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALIGN_CENTER` The `RichTextFeature` to change the text `Justification` to `HorizontalAlignment.CENTER`.
`ALIGN_LEFT` The `RichTextFeature` to change the text `Justification` to `HorizontalAlignment.LEFT`.
`ALIGN_RIGHT` The `RichTextFeature` to change the text `Justification` to `HorizontalAlignment.RIGHT`.
`BACKGROUND_COLOR` The `RichTextFeature` to change the background color.
`BOLD` The `RichTextFeature` to toggle bold text.
`FONT_COLOR` The `RichTextFeature` to change the text color.
`FONT_FAMILY` The `RichTextFeature` to change the font family of the text.
`FONT_SIZE` The `RichTextFeature` to change the font size of the text.
`HORIZONTAL_LINE` The `RichTextFeature` to insert a horizontal line.
`INDENT` The `RichTextFeature` to indent text.
`INSERT_IMAGE` The `RichTextFeature` to insert images.
`INSERT_LINK` The `RichTextFeature` to insert links.
`ITALIC` The `RichTextFeature` to toggle italic text.
`ORDERED_LIST` The `RichTextFeature` to toggle an ordered list.
`OUTDENT` The `RichTextFeature` to outdent text.
`REDO` The `RichTextFeature` to undo the re-do a change after an `undo`.
`REMOVE_FORMAT` The `RichTextFeature` to change remove all formatting (styling markup) from the text.
`STRIKETHROUGH` The `RichTextFeature` to toggle ~~strikethrough~~ text.
`SUBSCRIPT` The `RichTextFeature` to toggle _subscript text.
`SUPERSCRIPT` The `RichTextFeature` to toggle ^superscript text.
`UNDERLINE` The `RichTextFeature` to toggle underlined text.
`UNDO` The `RichTextFeature` to undo the last change.
`UNORDERED_LIST` The `RichTextFeature` to toggle an unordered list.

Field Summary

Fields
Modifier and Type Field and Description

private static NlsBundleClientUiRoot bundle

private String icon
- Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject
  KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Fields
Modifier and Type	Field and Description
`private static NlsBundleClientUiRoot`	`bundle`
`private String`	`icon`

Method Summary

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

Methods inherited from interface net.sf.mmm.util.nls.api.NlsObject
toNlsMessage

- Enum Constant Detail
  - BOLD
```
public static final RichTextFeature BOLD
```
    The RichTextFeature to toggle bold text.
  - ITALIC
```
public static final RichTextFeature ITALIC
```
    The RichTextFeature to toggle italic text.
  - UNDERLINE
```
public static final RichTextFeature UNDERLINE
```
    The RichTextFeature to toggle underlined text.
  - SUBSCRIPT
```
public static final RichTextFeature SUBSCRIPT
```
    The RichTextFeature to toggle _subscript text.
  - SUPERSCRIPT
```
public static final RichTextFeature SUPERSCRIPT
```
    The RichTextFeature to toggle ^superscript text.
  - STRIKETHROUGH
```
public static final RichTextFeature STRIKETHROUGH
```
    The RichTextFeature to toggle ~~strikethrough~~ text.
  - ALIGN_LEFT
```
public static final RichTextFeature ALIGN_LEFT
```
    The RichTextFeature to change the text Justification to HorizontalAlignment.LEFT.
  - ALIGN_CENTER
```
public static final RichTextFeature ALIGN_CENTER
```
    The RichTextFeature to change the text Justification to HorizontalAlignment.CENTER.
  - ALIGN_RIGHT
```
public static final RichTextFeature ALIGN_RIGHT
```
    The RichTextFeature to change the text Justification to HorizontalAlignment.RIGHT.
  - ORDERED_LIST
```
public static final RichTextFeature ORDERED_LIST
```
    The RichTextFeature to toggle an ordered list. E.g.:
    1. fist item
    2. second item
  - UNORDERED_LIST
```
public static final RichTextFeature UNORDERED_LIST
```
    The RichTextFeature to toggle an unordered list. E.g.:
    - fist item
    - second item
  - HORIZONTAL_LINE
```
public static final RichTextFeature HORIZONTAL_LINE
```
    The RichTextFeature to insert a
    horizontal line.
  - INSERT_IMAGE
```
public static final RichTextFeature INSERT_IMAGE
```
    The RichTextFeature to insert images.
  - INSERT_LINK
```
public static final RichTextFeature INSERT_LINK
```
    The RichTextFeature to insert links.
  - FONT_FAMILY
```
public static final RichTextFeature FONT_FAMILY
```
    The RichTextFeature to change the font family of the text.
  - FONT_SIZE
```
public static final RichTextFeature FONT_SIZE
```
    The RichTextFeature to change the font size of the text.
  - FONT_COLOR
```
public static final RichTextFeature FONT_COLOR
```
    The RichTextFeature to change the text color.
  - BACKGROUND_COLOR
```
public static final RichTextFeature BACKGROUND_COLOR
```
    The RichTextFeature to change the background color.
  - REMOVE_FORMAT
```
public static final RichTextFeature REMOVE_FORMAT
```
    The RichTextFeature to change remove all formatting (styling markup) from the text.
  - INDENT
```
public static final RichTextFeature INDENT
```
    The RichTextFeature to indent text.
  - OUTDENT
```
public static final RichTextFeature OUTDENT
```
    The RichTextFeature to outdent text.
  - UNDO
```
public static final RichTextFeature UNDO
```
    The RichTextFeature to undo the last change.
  - REDO
```
public static final RichTextFeature REDO
```
    The RichTextFeature to undo the re-do a change after an undo.
- Field Detail
  - bundle
```
private static NlsBundleClientUiRoot bundle
```
    See Also:
    
    getBundle()
  - icon
```
private final String icon
```
    See Also:
    
    getIcon()
- Method Detail
  - values
```
public static RichTextFeature[] 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 (RichTextFeature c : RichTextFeature.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RichTextFeature 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
  - getIcon
```
public String getIcon()
```
    Returns:
    
    the name of the icon for this feature.
  - getBundle
```
private static NlsBundleClientUiRoot getBundle()
```
    Returns:
    
    the instance of NlsBundleClientUiRoot.

Enum RichTextFeature

Enum Constant Summary

Field Summary

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.mmm.util.nls.api.NlsObject

Enum Constant Detail

BOLD

ITALIC

UNDERLINE

SUBSCRIPT

SUPERSCRIPT

STRIKETHROUGH

ALIGN_LEFT

ALIGN_CENTER

ALIGN_RIGHT

ORDERED_LIST

UNORDERED_LIST

HORIZONTAL_LINE

INSERT_IMAGE

INSERT_LINK

FONT_FAMILY

FONT_SIZE

FONT_COLOR

BACKGROUND_COLOR

REMOVE_FORMAT

INDENT

OUTDENT

UNDO

REDO

Field Detail

bundle

icon

Method Detail

values

valueOf

getIcon

getBundle