Class PlaceHolder

    • Method Detail

      • getAlias

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

        public String getDetailedDescription​(Locale locale)
        Parameters:
        locale - Current locale.
        Returns:
        Detailed description of this placeholder, such as explaning what it does for system placeholders.
      • getIcon

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

        public String getIconStyleClass()
        Returns:
        Style class for displaying the icon
      • getIconValue

        public String getIconValue()
        Returns:
        Value for displaying the icon (text content of the span element)
      • getKind

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

        public String getName()
        Returns:
        Name of the placeholder, e.g. CLIENT_ID. Usually shown in the list of available placeholders
      • getPlaceholder

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

        public String getShortDescription​(Locale locale)
        Parameters:
        locale - Current locale.
        Returns:
        A short description that is shown for this placeholder, usually its name.
      • getText

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

        public IPlaceholderType getType()
        Returns:
        Type of this placeholder (system, form, custom etc).
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isEmpty

        public boolean isEmpty()
      • empty

        public static PlaceHolder empty​(EPlaceholderType type)
        Parameters:
        type - Type of placeholder
        Returns:
        A new empty placeholder that cannot be inserted into a text field. Usually this is shown in the list of placeholders when no placeholders are available.