Package de.xima.fc.form.common.models

Enum EFormThemeReferenceKind

java.lang.Object

java.lang.Enum<EFormThemeReferenceKind>

de.xima.fc.form.common.models.EFormThemeReferenceKind

All Implemented Interfaces:

Serializable, Comparable<EFormThemeReferenceKind>

public enum EFormThemeReferenceKind
extends Enum<EFormThemeReferenceKind>

Enumeration of the possible types of FormThemeReference.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT_FORM_THEME	A FormThemeReference.ClientFormTheme.
FORM_THEME_PLUGIN	A FormThemeReference.FormThemePlugin.
SYSTEM	A FormThemeReference.System.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_CLIENT_FORM_THEME	The name for the CLIENT_FORM_THEME type.
static String	TYPE_FORM_THEME_PLUGIN	The name for the FORM_THEME_PLUGIN type.
static String	TYPE_SYSTEM	The name for the SYSTEM type.

Method Summary

Modifier and Type	Method	Description
static EFormThemeReferenceKind	byTypeNameOrNull(String typeName)	Returns the EFormThemeReferenceKind for the given type name, or null if no such type exists.
String	getDisplayName(Locale locale)	Returns the display name of this kind of form theme reference in the given locale.
abstract String	getTypeName()	Gets the canonical type name for this kind of form theme reference.
static EFormThemeReferenceKind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EFormThemeReferenceKind[]	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

CLIENT_FORM_THEME

public static final EFormThemeReferenceKind CLIENT_FORM_THEME

A FormThemeReference.ClientFormTheme.

FORM_THEME_PLUGIN

public static final EFormThemeReferenceKind FORM_THEME_PLUGIN

A FormThemeReference.FormThemePlugin.

SYSTEM

public static final EFormThemeReferenceKind SYSTEM

A FormThemeReference.System.

Field Detail

TYPE_CLIENT_FORM_THEME

public static final String TYPE_CLIENT_FORM_THEME

The name for the CLIENT_FORM_THEME type.

See Also:

Constant Field Values

TYPE_FORM_THEME_PLUGIN

public static final String TYPE_FORM_THEME_PLUGIN

The name for the FORM_THEME_PLUGIN type.

See Also:

Constant Field Values

TYPE_SYSTEM

public static final String TYPE_SYSTEM

The name for the SYSTEM type.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getDisplayName

public String getDisplayName(Locale locale)

Returns the display name of this kind of form theme reference in the given locale.

Parameters:

locale - The locale to use.

Returns:

The display name of this kind of form theme reference in the given locale.

getTypeName

public abstract String getTypeName()

Gets the canonical type name for this kind of form theme reference.

Returns:

The canonical type name for this kind of form theme reference.

See Also:

byTypeNameOrNull(String)

byTypeNameOrNull

public static EFormThemeReferenceKind byTypeNameOrNull(String typeName)

Returns the EFormThemeReferenceKind for the given type name, or null if no such type exists.

Parameters:

typeName - The type name to look up.

Returns:

The corresponding EFormThemeReferenceKind, or null if no such type exists.