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 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 ofI_CmsContextMenuEntry
objects.boolean
hasSubMenu()
Returnstrue
if this menu entry has a sub menufalse
otherwise.boolean
isActive()
Returnstrue
if this menu entry is activefalse
otherwise.boolean
isSeparator()
Returnstrue
if this menu entry is a separatorfalse
otherwise.boolean
isVisible()
Returnstrue
if this menu entry is visiblefalse
otherwise.
-
-
-
Method Detail
-
execute
void execute()
Executes the context menu action.
-
generateMenuItem
A_CmsContextMenuItem generateMenuItem()
Generates the context menu item.- Returns:
- the context menu item
-
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
-
getSubMenu
java.util.List<I_CmsContextMenuEntry> getSubMenu()
Returns a list ofI_CmsContextMenuEntry
objects.- Returns:
- the sub menu entries
-
hasSubMenu
boolean hasSubMenu()
Returnstrue
if this menu entry has a sub menufalse
otherwise.- Returns:
true
if this menu entry has a sub menufalse
otherwise
-
isActive
boolean isActive()
Returnstrue
if this menu entry is activefalse
otherwise.- Returns:
true
if this menu entry is activefalse
otherwise
-
isSeparator
boolean isSeparator()
Returnstrue
if this menu entry is a separatorfalse
otherwise.- Returns:
true
if this menu entry is a separatorfalse
otherwise
-
isVisible
boolean isVisible()
Returnstrue
if this menu entry is visiblefalse
otherwise.- Returns:
true
if this menu entry is visiblefalse
otherwise
-
-