Package org.opencms.jsp.util

Interface I_CmsFormatterInfo

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String description​(java.util.Locale l)
      Gets the description in the given locale.
      java.lang.String getDescription()
      Gets the description in the current locale.
      java.lang.String getDescriptionKey()
      Returns the localization key for the description if one was used, and null otherwise.
      java.lang.String getDescriptionRaw()
      Gets the raw description, without resolving any macros.
      boolean getIsActive()
      Checks if this is active.
      boolean getIsFormatter()
      Checks if this wraps a (non-function) formatter.
      boolean getIsFunction()
      Checks if this wraps a dynamic function.
      boolean getIsResourceType()
      Checks if this wraps a resource type.
      java.lang.String getName()
      Gets the name.
      java.lang.String getNiceName()
      Gets the nice name for the current locale.
      java.lang.String getNiceNameKey()
      Gets the localization key for the nice name, if one was used, or null otherwise.
      java.lang.String getNiceNameRaw()
      Gets the raw nice name, without resolving any macros.
      java.lang.String niceName​(java.util.Locale l)
      Gets the nice name in the given locale.

    • Method Detail

      • description

        java.lang.String description​(java.util.Locale l)
        Gets the description in the given locale.
        Parameters:
        l - the locale to use
        Returns:
        the description

      • getDescription

        java.lang.String getDescription()
        Gets the description in the current locale.
        Returns:
        the locale to use

      • getDescriptionKey

        java.lang.String getDescriptionKey()
        Returns the localization key for the description if one was used, and null otherwise.
        Returns:
        the localization key

      • getDescriptionRaw

        java.lang.String getDescriptionRaw()
        Gets the raw description, without resolving any macros.
        Returns:
        the raw description

      • getIsActive

        boolean getIsActive()
        Checks if this is active.
        Returns:
        true if this is active

      • getIsFormatter

        boolean getIsFormatter()
        Checks if this wraps a (non-function) formatter.
        Returns:
        true if this wraps a normal formatter

      • getIsFunction

        boolean getIsFunction()
        Checks if this wraps a dynamic function.
        Returns:
        true if this wraps a dynamic function

      • getIsResourceType

        boolean getIsResourceType()
        Checks if this wraps a resource type.
        Returns:
        true if this is a resource type

      • getName

        java.lang.String getName()
        Gets the name.
        Returns:
        the name

      • getNiceName

        java.lang.String getNiceName()
        Gets the nice name for the current locale.
        Returns:
        the nice name for the current locale

      • getNiceNameKey

        java.lang.String getNiceNameKey()
        Gets the localization key for the nice name, if one was used, or null otherwise.
        Returns:
        the localization key

      • getNiceNameRaw

        java.lang.String getNiceNameRaw()
        Gets the raw nice name, without resolving any macros.
        Returns:
        the raw nice name

      • niceName

        java.lang.String niceName​(java.util.Locale l)
        Gets the nice name in the given locale.
        Parameters:
        l - the locale to use
        Returns:
        the nice name for the locale