Interface I_CmsContextMenuEntry

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void execute()
      Executes the context menu action.
      A_CmsContextMenuItem generateMenuItem()
      Generates the context menu item.
      java.lang.String getIconClass()
      Returns a CSS class which should be used to display an icon, or null if no icon is required.
      java.lang.String getJspPath()
      Returns the JSP path for the command generation.
      java.lang.String getLabel()
      Returns the label (text) for the menu entry.
      java.lang.String getName()
      Returns the name of the entry.
      java.lang.String getReason()
      Returns the reason if the entry is de-activated .
      java.util.List<I_CmsContextMenuEntry> getSubMenu()
      Returns a list of I_CmsContextMenuEntry objects.
      boolean hasSubMenu()
      Returns true if this menu entry has a sub menu false otherwise.
      boolean isActive()
      Returns true if this menu entry is active false otherwise.
      boolean isSeparator()
      Returns true if this menu entry is a separator false otherwise.
      boolean isVisible()
      Returns true if this menu entry is visible false otherwise.
    • Method Detail

      • execute

        void execute()
        Executes the context menu action.

      • getIconClass

        java.lang.String getIconClass()
        Returns a CSS class which should be used to display an icon, or null if no icon is required.

        Returns:
        the CSS class for the icon
      • getJspPath

        java.lang.String getJspPath()
        Returns the JSP path for the command generation.

        Returns:
        the JSP path
      • getLabel

        java.lang.String getLabel()
        Returns the label (text) for the menu entry.

        Returns:
        the label
      • getName

        java.lang.String getName()
        Returns the name of the entry.

        Returns:
        the name of the entry
      • getReason

        java.lang.String getReason()
        Returns the reason if the entry is de-activated .

        Returns:
        the reason
      • hasSubMenu

        boolean hasSubMenu()
        Returns true if this menu entry has a sub menu false otherwise.

        Returns:
        true if this menu entry has a sub menu false otherwise
      • isActive

        boolean isActive()
        Returns true if this menu entry is active false otherwise.

        Returns:
        true if this menu entry is active false otherwise
      • isSeparator

        boolean isSeparator()
        Returns true if this menu entry is a separator false otherwise.

        Returns:
        true if this menu entry is a separator false otherwise
      • isVisible

        boolean isVisible()
        Returns true if this menu entry is visible false otherwise.

        Returns:
        true if this menu entry is visible false otherwise