Package com.hybris.backoffice.actionbar

Interface ActionDefinition

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Returns the description of the node.
      java.lang.String getDescriptionLocKey()
      Returns the localization key for the description of the node.
      default java.lang.String getGroup()
      Returns a group name for a node.
      java.lang.String getIconUri()
      Returns the icon URI of the node.
      java.lang.String getIconUriLocKey()
      Returns the localization key for the icon URI of the node.
      java.lang.String getId()
      Returns the ID of the node.
      java.lang.String getName()
      Returns the name of the node.
      java.lang.String getNameLocKey()
      Returns the localization key for the name of the node.

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the ID of the node. Should be unique within the tree structure.
        Returns:
        ID of the node

      • getNameLocKey

        java.lang.String getNameLocKey()
        Returns the localization key for the name of the node. This will be used to get the localized name of the node in the current Locale. If this is null then getName() is used as the node name.
        Returns:
        localization key for the name of the node or null if getName() is should be used as the node name
        See Also:
        getName()

      • getName

        java.lang.String getName()
        Returns the name of the node. This is only used as a node name if the localization key for the node name is not set (see getNameLocKey()).
        Returns:
        the name of the node
        See Also:
        getNameLocKey()

      • getDescriptionLocKey

        java.lang.String getDescriptionLocKey()
        Returns the localization key for the description of the node. This will be used to get the localized description of the node in the current Locale. If this is null then getDescription() is used as the node description.
        Returns:
        localization key for the description of the node or null if getDescription() is should be used as the node description
        See Also:
        getDescription()

      • getDescription

        java.lang.String getDescription()
        Returns the description of the node. This is only used as a node description if the localization key for the node description is not set (see getDescriptionLocKey()).
        Returns:
        the description of the node
        See Also:
        getDescriptionLocKey()

      • getIconUriLocKey

        java.lang.String getIconUriLocKey()
        Returns the localization key for the icon URI of the node. This will be used to get the localized icon URI of the node in the current Locale. If this is null then getIconUri() is used as the node description.
        Returns:
        localization key for the icon URI of the node or null if getIconUri() is should be used as the node icon URI
        See Also:
        getIconUri()

      • getIconUri

        java.lang.String getIconUri()
        Returns the icon URI of the node. This is only used as a node icon URI if the localization key for the node icon URI is not set (see getIconUriLocKey()).
        Returns:
        the icon URI of the node
        See Also:
        getIconUriLocKey()

      • getGroup

        default java.lang.String getGroup()
        Returns a group name for a node.

        Interpretation of group depends totally on toolbar's implementation.

        Returns:
        name of group or null if not applicable