Package de.xima.fc.gui.statics

Interface IPlaceholderType

  • All Known Implementing Classes:
    ContextPlaceholderType, EPlaceholderType
    public interface IPlaceholderType
    Represents a placeholder type by which the available placeholders are grouped when displayed. Contains methods for computing the the name and description of the placeholder to avoid having to do so manually for each individual placeholder.
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • getDisplayName

        String getDisplayName​(Locale locale)
        Parameters:
        locale - The current language settings.
        Returns:
        The name of this placeholder type, shown as the header of the group.

      • getShortDescription

        String getShortDescription​(PlaceHolder placeholder,
                           Locale locale)
        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

      • getDetailedDescription

        String getDetailedDescription​(PlaceHolder placeholder,
                              Locale locale)
        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.

      • getIcon

        IGuiIcon getIcon​(PlaceHolder placeholder)
        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.

      • isExpandInitially

        boolean isExpandInitially()
        Returns:
        true True if this category should be expanded initially, false otherwise.

      • getId

        String getId()
        Returns:
        The ID of this placeholder type, used for grouping individual placeholders according to their type.

      • getSortKeyFirst

        int getSortKeyFirst()
        Returns:
        Key by which placeholders types are sorted first.

      • getSortKeySecond

        String getSortKeySecond()
        Returns:
        Key by which placeholders types are sorted second (when the getSortKeyFirst() are the same).