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

Interface IPlaceholder

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    PlaceHolder
    public interface IPlaceholder
extends Serializable
    Common interface for placeholders.
    Since:
    8.4.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • getAlias

        String getAlias()
        Returns:
        Only for form field placeholders: The alias of the form field.

      • getDetailedDescription

        String getDetailedDescription​(Locale locale)
        Parameters:
        locale - The locale to get the description for.
        Returns:
        Detailed description of this placeholder, explaining what it does and how it works.

      • getDisplayName

        String getDisplayName​(Locale locale)
        Parameters:
        locale - The locale to get the display name for.
        Returns:
        Display name of the placeholder, e.g. Client ID. Usually shown in the list of available placeholders

      • getIcon

        IGuiIcon getIcon()
        Returns:
        Icon for this placeholder. Depending on the placeholder type, may overwrite the default icon of that type.

      • getKind

        @Deprecated
String getKind()
        Deprecated.
        Returns:
        The type or kind of the placeholder. May be used by certain IPlaceholderTypes for a more detailed description etc.

      • getPlaceholder

        String getPlaceholder()
        Returns:
        full placeholder name with the brackets, eg. [%$CLIENT_ID%]. Used when inserting the placeholder in an input field

      • getShortDescription

        @Deprecated
String getShortDescription​(Locale locale)
        Deprecated.
        Use getDisplayName(Locale) instead.
        Parameters:
        locale - The locale to get the description for.
        Returns:
        Short description of this placeholder, explaining what it does.

      • getSortKey

        Comparable<?> getSortKey()
        Returns:
        The sort key of this placeholder. Used for sorting placeholders in the list of available placeholders.

      • getText

        String getText()
        Returns:
        Content of this placeholder, eg. the HTML string for HTML template placeholders.

      • getType

        @NotNull
@NotNull IPlaceholderType getType()
        Returns:
        Type of this placeholder (e.g. system, template, form field, etc.)