Package de.xima.fc.gui.common.placeholder

Enum EPlaceholderInsertHint

java.lang.Object

java.lang.Enum<EPlaceholderInsertHint>

de.xima.fc.gui.common.placeholder.EPlaceholderInsertHint

All Implemented Interfaces:

Serializable, Comparable<EPlaceholderInsertHint>

public enum EPlaceholderInsertHint
extends Enum<EPlaceholderInsertHint>

A placeholder insertion hint describes the way a placeholder prefers to be inserted into input components (if it is supported by the respective input component).

Since:

8.4.1

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTML	Insert as HTML text if supported by the target component.
LINK	Insert as a link if supported by the target component (e.g.
TEXT	Insert as plain text, the default (and fallback), should be supported by all target components.

Method Summary

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

Insert as plain text, the default (and fallback), should be supported by all target components.

HTML

public static final EPlaceholderInsertHint HTML

Insert as HTML text if supported by the target component.

LINK

public static final EPlaceholderInsertHint LINK

Insert as a link if supported by the target component (e.g. if the placeholder stands for a URL).

Method Detail

values

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

Returns:

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

valueOf

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

getHintName

public String getHintName()

Returns:

the lower case name of the enum constant, see also the related InsertHints constant in fc-backend-common-gui/src/main/web/src/core/Header.ts