com.vaadin.shared.ui

Enum ContentMode

java.lang.Object

java.lang.Enum<ContentMode>

com.vaadin.shared.ui.ContentMode

All Implemented Interfaces:

Serializable, Comparable<ContentMode>

public enum ContentMode
extends Enum<ContentMode>

Defines how the client should interpret textual values.

Since:

8.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML Textual values are interpreted and displayed as HTML.
PREFORMATTED Textual values are displayed as preformatted text.
TEXT Textual values are displayed as plain text.

Method Summary

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

TEXT

public static final ContentMode TEXT

Textual values are displayed as plain text.

PREFORMATTED

public static final ContentMode PREFORMATTED

Textual values are displayed as preformatted text. In this mode newlines are preserved when rendered on the screen.

HTML

public static final ContentMode HTML

Textual values are interpreted and displayed as HTML. Care should be taken when using this mode to avoid Cross-site Scripting (XSS) issues.

Method Detail

values

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

Returns:

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

valueOf

public static ContentMode 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