Class A_CmsSitemapMenuEntry
- java.lang.Object
-
- org.opencms.ade.sitemap.client.hoverbar.A_CmsSitemapMenuEntry
-
- All Implemented Interfaces:
I_CmsContextMenuEntry
- Direct Known Subclasses:
CmsAddToNavMenuEntry
,CmsAdvancedSubmenu
,CmsAvailabilityMenuEntry
,CmsBumpDetailPageMenuEntry
,CmsChangeCategoryMenuEntry
,CmsCopyAsModelGroupPageMenuEntry
,CmsCopyModelPageMenuEntry
,CmsCopyPageMenuEntry
,CmsCreateCategoryMenuEntry
,CmsCreateGalleryMenuEntry
,CmsDeleteCategoryMenuEntry
,CmsDeleteMenuEntry
,CmsDeleteModelPageMenuEntry
,CmsDisableMenuEntry
,CmsEditMenuEntry
,CmsEditModelPageMenuEntry
,CmsEditRedirectMenuEntry
,CmsGotoExplorerMenuEntry
,CmsGotoMenuEntry
,CmsGotoSubSitemapMenuEntry
,CmsHideMenuEntry
,CmsLockReportMenuEntry
,CmsMergeMenuEntry
,CmsNewChoiceMenuEntry
,CmsOpenGalleryMenuEntry
,CmsParentSitemapMenuEntry
,CmsRefreshMenuEntry
,CmsRemoveMenuEntry
,CmsResourceInfoMenuEntry
,CmsSeoMenuEntry
,CmsSetDefaultModelMenuEntry
,CmsShowMenuEntry
,CmsSubSitemapMenuEntry
public abstract class A_CmsSitemapMenuEntry extends java.lang.Object implements I_CmsContextMenuEntry
Common super class for all sitemap context menu entries.- Since:
- 8.0.0
-
-
Constructor Summary
Constructors Constructor Description A_CmsSitemapMenuEntry(CmsSitemapHoverbar hoverbar)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
deattachHoverbar()
De-attaches the hoverbar.A_CmsContextMenuItem
generateMenuItem()
Generates the context menu item.protected CmsSitemapHoverbar
getHoverbar()
Returns the hoverbar.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.abstract void
onShow()
Executed when the context-menu is opened.void
setActive(boolean active)
Sets if this menu entry is active.void
setDisabledReason(java.lang.String reason)
Sets the reason if the entry is de-activated.void
setLabel(java.lang.String label)
Sets the label (text) for the menu entry.void
setVisible(boolean visible)
Sets if the menu entry is visible.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuEntry
execute
-
-
-
-
Constructor Detail
-
A_CmsSitemapMenuEntry
public A_CmsSitemapMenuEntry(CmsSitemapHoverbar hoverbar)
Constructor.- Parameters:
hoverbar
- the hoverbar
-
-
Method Detail
-
generateMenuItem
public A_CmsContextMenuItem generateMenuItem()
Description copied from interface:I_CmsContextMenuEntry
Generates the context menu item.- Specified by:
generateMenuItem
in interfaceI_CmsContextMenuEntry
- Returns:
- the context menu item
- See Also:
I_CmsContextMenuEntry.generateMenuItem()
-
getIconClass
public java.lang.String getIconClass()
Description copied from interface:I_CmsContextMenuEntry
Returns a CSS class which should be used to display an icon, or null if no icon is required.- Specified by:
getIconClass
in interfaceI_CmsContextMenuEntry
- Returns:
- the CSS class for the icon
- See Also:
I_CmsContextMenuEntry.getIconClass()
-
getJspPath
public java.lang.String getJspPath()
Description copied from interface:I_CmsContextMenuEntry
Returns the JSP path for the command generation.- Specified by:
getJspPath
in interfaceI_CmsContextMenuEntry
- Returns:
- the JSP path
- See Also:
I_CmsContextMenuEntry.getJspPath()
-
getLabel
public java.lang.String getLabel()
Description copied from interface:I_CmsContextMenuEntry
Returns the label (text) for the menu entry.- Specified by:
getLabel
in interfaceI_CmsContextMenuEntry
- Returns:
- the label
- See Also:
I_CmsContextMenuEntry.getLabel()
-
getName
public java.lang.String getName()
Description copied from interface:I_CmsContextMenuEntry
Returns the name of the entry.- Specified by:
getName
in interfaceI_CmsContextMenuEntry
- Returns:
- the name of the entry
- See Also:
I_CmsContextMenuEntry.getName()
-
getReason
public java.lang.String getReason()
Description copied from interface:I_CmsContextMenuEntry
Returns the reason if the entry is de-activated .- Specified by:
getReason
in interfaceI_CmsContextMenuEntry
- Returns:
- the reason
- See Also:
I_CmsContextMenuEntry.getReason()
-
getSubMenu
public java.util.List<I_CmsContextMenuEntry> getSubMenu()
Description copied from interface:I_CmsContextMenuEntry
Returns a list ofI_CmsContextMenuEntry
objects.- Specified by:
getSubMenu
in interfaceI_CmsContextMenuEntry
- Returns:
- the sub menu entries
- See Also:
I_CmsContextMenuEntry.getSubMenu()
-
hasSubMenu
public boolean hasSubMenu()
Description copied from interface:I_CmsContextMenuEntry
Returnstrue
if this menu entry has a sub menufalse
otherwise.- Specified by:
hasSubMenu
in interfaceI_CmsContextMenuEntry
- Returns:
true
if this menu entry has a sub menufalse
otherwise- See Also:
I_CmsContextMenuEntry.hasSubMenu()
-
isActive
public boolean isActive()
Description copied from interface:I_CmsContextMenuEntry
Returnstrue
if this menu entry is activefalse
otherwise.- Specified by:
isActive
in interfaceI_CmsContextMenuEntry
- Returns:
true
if this menu entry is activefalse
otherwise- See Also:
I_CmsContextMenuEntry.isActive()
-
isSeparator
public boolean isSeparator()
Description copied from interface:I_CmsContextMenuEntry
Returnstrue
if this menu entry is a separatorfalse
otherwise.- Specified by:
isSeparator
in interfaceI_CmsContextMenuEntry
- Returns:
true
if this menu entry is a separatorfalse
otherwise- See Also:
I_CmsContextMenuEntry.isSeparator()
-
isVisible
public boolean isVisible()
Description copied from interface:I_CmsContextMenuEntry
Returnstrue
if this menu entry is visiblefalse
otherwise.- Specified by:
isVisible
in interfaceI_CmsContextMenuEntry
- Returns:
true
if this menu entry is visiblefalse
otherwise- See Also:
I_CmsContextMenuEntry.isVisible()
-
onShow
public abstract void onShow()
Executed when the context-menu is opened.
-
setActive
public void setActive(boolean active)
Sets if this menu entry is active.- Parameters:
active
-true
to set this menu entry active
-
setDisabledReason
public void setDisabledReason(java.lang.String reason)
Sets the reason if the entry is de-activated.- Parameters:
reason
- the reason if the entry is de-activated
-
setLabel
public void setLabel(java.lang.String label)
Sets the label (text) for the menu entry.- Parameters:
label
- the label (text) for the menu entry
-
setVisible
public void setVisible(boolean visible)
Sets if the menu entry is visible.- Parameters:
visible
-true
to set the entry visible
-
deattachHoverbar
protected void deattachHoverbar()
De-attaches the hoverbar.
-
getHoverbar
protected CmsSitemapHoverbar getHoverbar()
Returns the hoverbar.- Returns:
- the hoverbar
-
-