Package org.opencms.gwt.client.ui.contextmenu

Interface I_CmsContextMenuEntry

All Known Implementing Classes:
A_CmsSitemapMenuEntry, A_CmsSitemapModeEntry, CmsAddToNavMenuEntry, CmsAdvancedSubmenu, CmsAvailabilityMenuEntry, CmsBumpDetailPageMenuEntry, CmsChangeCategoryMenuEntry, CmsContextMenuEntry, CmsCopyAsModelGroupPageMenuEntry, CmsCopyModelPageMenuEntry, CmsCopyPageMenuEntry, CmsCreateCategoryMenuEntry, CmsCreateGalleryMenuEntry, CmsDeleteCategoryMenuEntry, CmsDeleteMenuEntry, CmsDeleteModelPageMenuEntry, CmsDisableMenuEntry, CmsEditMenuEntry, CmsEditModelPageMenuEntry, CmsEditRedirectMenuEntry, CmsGotoExplorerMenuEntry, CmsGotoMenuEntry, CmsGotoSubSitemapMenuEntry, CmsHideMenuEntry, CmsLockReportMenuEntry, CmsMergeMenuEntry, CmsModelPageLockReportMenuEntry, CmsNewChoiceMenuEntry, CmsOpenGalleryMenuEntry, CmsParentSitemapMenuEntry, CmsRefreshMenuEntry, CmsRemoveMenuEntry, CmsResourceInfoMenuEntry, CmsSeoMenuEntry, CmsSetDefaultModelMenuEntry, CmsShowMenuEntry, CmsSubSitemapMenuEntry
public interface I_CmsContextMenuEntry
Interface for a context menu entry.

Since:
version 8.0.0

  • Method Details

    • execute

      void execute()
      Executes the context menu action.

    • generateMenuItem

      A_CmsContextMenuItem generateMenuItem()
      Generates the context menu item.

      Returns:
      the context menu item

    • getIconClass

      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

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

      Returns:
      the JSP path

    • getLabel

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

      Returns:
      the label

    • getName

      String getName()
      Returns the name of the entry.

      Returns:
      the name of the entry

    • getReason

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

      Returns:
      the reason

    • getSubMenu

      List<I_CmsContextMenuEntry> getSubMenu()
      Returns a list of I_CmsContextMenuEntry objects.

      Returns:
      the sub menu entries

    • 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