TextMode (Cyclos 4.15.15 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<TextMode>
- - org.cyclos.model.TextMode

All Implemented Interfaces:

Serializable, Comparable<TextMode>
```
public enum TextMode
extends Enum<TextMode>
```
Determines how textual data is handled

Enum Constant Summary

Enum Constants
Enum Constant	Description
`PLAIN`	Text is handled as plain: Any "<" is replaced by "< ", effectively escaping all HTML tags.
`RAW`	Text is not sanitized in any way
`RICH`	Text is handled as rich text: It is sanitized for the allowed markup

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static TextMode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static TextMode[]`	`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
  - PLAIN
```
public static final TextMode PLAIN
```
    Text is handled as plain: Any "<" is replaced by "< ", effectively escaping all HTML tags.
  - RICH
```
public static final TextMode RICH
```
    Text is handled as rich text: It is sanitized for the allowed markup
  - RAW
```
public static final TextMode RAW
```
    Text is not sanitized in any way
- Method Detail
  - values
```
public static TextMode[] 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 (TextMode c : TextMode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TextMode 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