Package de.xima.fc.gui.statics
Enum EPlaceholderType
- java.lang.Object
-
- java.lang.Enum<EPlaceholderType>
-
- de.xima.fc.gui.statics.EPlaceholderType
-
- All Implemented Interfaces:
IPlaceholderType
,INamedUiElement
,Serializable
,Comparable<EPlaceholderType>
public enum EPlaceholderType extends Enum<EPlaceholderType> implements INamedUiElement, IPlaceholderType
Common placeholder types. Contains methods for getting a name and description, which may differ for different types of placeholders. For example, a placeholder of typeSYSTEM
is displayed asCLIENT_ID - ID of the current client
, whereas a placeholder of typeTEMPLATE_HTML
is displayed as[TEMPLATE_NAME] [TEMPLATE_CONTENT]
.- Author:
- XIMA MEDIA GmbH
-
-
Enum Constant Summary
Enum Constants Enum Constant Description APPOINTMENT
ATTACHMENT
COUNTER
FORM_COLLECTION
FORM_SIMPLE
FORM_UPLOAD
INITIAL_USER
LAST_USER
OTHER
Fallback when no more specific type could be determined.SYSTEM
TEMPLATE_HTML
TEMPLATE_MAIL
TEMPLATE_TEXT
TEMPLATE_URL
USER
WEBDAV_CONNECTION
WORKFLOW_ACTION_RESULT
WORKFLOW_NODE
WORKFLOW_TRIGGER
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
ATTR_DISPLAY_NAME
-
Fields inherited from interface de.xima.fc.gui.statics.IPlaceholderType
COMPARATOR
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static IPlaceholderType
forFormElementType(EFormElementTyp type)
static EPlaceholderType
forTemplate(ETextbausteinKategorie category)
abstract String
getDetailedDescription(PlaceHolder placeholder, Locale locale)
String
getDisplayName(Locale l)
The display name of this element in the given locale.abstract IGuiIcon
getIcon(PlaceHolder placeholder)
String
getId()
abstract String
getShortDescription(PlaceHolder placeholder, Locale locale)
int
getSortKeyFirst()
String
getSortKeySecond()
abstract boolean
isExpandInitially()
static EPlaceholderType
valueOf(String name)
Returns the enum constant of this type with the specified name.static EPlaceholderType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ATTACHMENT
public static final EPlaceholderType ATTACHMENT
-
FORM_COLLECTION
public static final EPlaceholderType FORM_COLLECTION
-
FORM_SIMPLE
public static final EPlaceholderType FORM_SIMPLE
-
FORM_UPLOAD
public static final EPlaceholderType FORM_UPLOAD
-
OTHER
public static final EPlaceholderType OTHER
Fallback when no more specific type could be determined.
-
SYSTEM
public static final EPlaceholderType SYSTEM
-
USER
public static final EPlaceholderType USER
-
INITIAL_USER
public static final EPlaceholderType INITIAL_USER
-
LAST_USER
public static final EPlaceholderType LAST_USER
-
APPOINTMENT
public static final EPlaceholderType APPOINTMENT
-
TEMPLATE_HTML
public static final EPlaceholderType TEMPLATE_HTML
-
TEMPLATE_MAIL
public static final EPlaceholderType TEMPLATE_MAIL
-
TEMPLATE_TEXT
public static final EPlaceholderType TEMPLATE_TEXT
-
TEMPLATE_URL
public static final EPlaceholderType TEMPLATE_URL
-
COUNTER
public static final EPlaceholderType COUNTER
-
WEBDAV_CONNECTION
public static final EPlaceholderType WEBDAV_CONNECTION
-
WORKFLOW_TRIGGER
public static final EPlaceholderType WORKFLOW_TRIGGER
-
WORKFLOW_NODE
public static final EPlaceholderType WORKFLOW_NODE
-
WORKFLOW_ACTION_RESULT
public static final EPlaceholderType WORKFLOW_ACTION_RESULT
-
-
Method Detail
-
values
public static EPlaceholderType[] 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 (EPlaceholderType c : EPlaceholderType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EPlaceholderType 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 nameNullPointerException
- if the argument is null
-
getDetailedDescription
public abstract String getDetailedDescription(PlaceHolder placeholder, Locale locale)
- Specified by:
getDetailedDescription
in interfaceIPlaceholderType
- Parameters:
placeholder
- A placeholder of this type for which to get the description.locale
- The current language settings- Returns:
- A detailed description for the given placeholder.
-
getDisplayName
public String getDisplayName(Locale l)
Description copied from interface:INamedUiElement
The display name of this element in the given locale.- Specified by:
getDisplayName
in interfaceINamedUiElement
- Specified by:
getDisplayName
in interfaceIPlaceholderType
- Parameters:
l
- The locale to get the display name for.- Returns:
- The display name of this element in the given locale.
-
getIcon
public abstract IGuiIcon getIcon(PlaceHolder placeholder)
- Specified by:
getIcon
in interfaceIPlaceholderType
- Parameters:
placeholder
- A placeholder of this type for which to get the icon.- Returns:
- Icon to be shown for the given placeholder. May be either a default icon for this group or a specific icon for the given placeholder.
-
getId
public String getId()
- Specified by:
getId
in interfaceIPlaceholderType
- Returns:
- The ID of this placeholder type, used for grouping individual placeholders according to their type.
-
getShortDescription
public abstract String getShortDescription(PlaceHolder placeholder, Locale locale)
- Specified by:
getShortDescription
in interfaceIPlaceholderType
- Parameters:
placeholder
- A placeholder of this type for which to get the description.locale
- The current language settings- Returns:
- A short description for the given placeholder
-
getSortKeyFirst
public int getSortKeyFirst()
- Specified by:
getSortKeyFirst
in interfaceIPlaceholderType
- Returns:
- Key by which placeholders types are sorted first.
-
getSortKeySecond
public String getSortKeySecond()
- Specified by:
getSortKeySecond
in interfaceIPlaceholderType
- Returns:
- Key by which placeholders types are sorted second (when the
IPlaceholderType.getSortKeyFirst()
are the same).
-
isExpandInitially
public abstract boolean isExpandInitially()
- Specified by:
isExpandInitially
in interfaceIPlaceholderType
- Returns:
true
True if this category should be expanded initially,false
otherwise.
-
forFormElementType
public static IPlaceholderType forFormElementType(EFormElementTyp type)
-
forTemplate
public static EPlaceholderType forTemplate(ETextbausteinKategorie category)
-
-