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 type SYSTEM is displayed as CLIENT_ID - ID of the current client, whereas a placeholder of type TEMPLATE_HTML is displayed as [TEMPLATE_NAME] [TEMPLATE_CONTENT].
Author:
XIMA MEDIA GmbH

  • Enum Constant Details

  • Method Details

    • values

      public static EPlaceholderType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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 name
      NullPointerException - if the argument is null

    • getDetailedDescription

      public abstract String getDetailedDescription(PlaceHolder placeholder, Locale locale)
      Specified by:
      getDetailedDescription in interface IPlaceholderType
      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)
      Specified by:
      getDisplayName in interface INamedUiElement
      Specified by:
      getDisplayName in interface IPlaceholderType
      Parameters:
      l - The current language settings.
      Returns:
      Wert, der das entsprechende Objekt an Oberfläche repräsentiert (wird i.A. zur Laufzeit ermittelt).

    • getIcon

      public abstract IGuiIcon getIcon(PlaceHolder placeholder)
      Specified by:
      getIcon in interface IPlaceholderType
      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 interface IPlaceholderType
      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 interface IPlaceholderType
      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 interface IPlaceholderType
      Returns:
      Key by which placeholders types are sorted first.

    • getSortKeySecond

      public String getSortKeySecond()
      Specified by:
      getSortKeySecond in interface IPlaceholderType
      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 interface IPlaceholderType
      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)