Package org.opencms.ade.sitemap.client.toolbar

Class A_CmsSitemapModeEntry

java.lang.Object

org.opencms.ade.sitemap.client.toolbar.A_CmsSitemapModeEntry

All Implemented Interfaces:

I_CmsContextMenuEntry

public abstract class A_CmsSitemapModeEntry
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_CmsSitemapModeEntry(java.lang.String label)	Constructor.

Method Summary

Modifier and Type	Method	Description
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.

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_CmsSitemapModeEntry

public A_CmsSitemapModeEntry(java.lang.String label)

Constructor.

Parameters:

label - the label

Method Detail

generateMenuItem

public A_CmsContextMenuItem generateMenuItem()

Description copied from interface: I_CmsContextMenuEntry

Generates the context menu item.

Specified by:

generateMenuItem in interface I_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 interface I_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 interface I_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 interface I_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 interface I_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 interface I_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 of I_CmsContextMenuEntry objects.

Specified by:

getSubMenu in interface I_CmsContextMenuEntry

Returns:

the sub menu entries

See Also:

I_CmsContextMenuEntry.getSubMenu()

hasSubMenu

public boolean hasSubMenu()

Description copied from interface: I_CmsContextMenuEntry

Returns true if this menu entry has a sub menu false otherwise.

Specified by:

hasSubMenu in interface I_CmsContextMenuEntry

Returns:

true if this menu entry has a sub menu false otherwise

See Also:

I_CmsContextMenuEntry.hasSubMenu()

isActive

public boolean isActive()

Description copied from interface: I_CmsContextMenuEntry

Returns true if this menu entry is active false otherwise.

Specified by:

isActive in interface I_CmsContextMenuEntry

Returns:

true if this menu entry is active false otherwise

See Also:

I_CmsContextMenuEntry.isActive()

isSeparator

public boolean isSeparator()

Description copied from interface: I_CmsContextMenuEntry

Returns true if this menu entry is a separator false otherwise.

Specified by:

isSeparator in interface I_CmsContextMenuEntry

Returns:

true if this menu entry is a separator false otherwise

See Also:

I_CmsContextMenuEntry.isSeparator()

isVisible

public boolean isVisible()

Description copied from interface: I_CmsContextMenuEntry

Returns true if this menu entry is visible false otherwise.

Specified by:

isVisible in interface I_CmsContextMenuEntry

Returns:

true if this menu entry is visible false otherwise

See Also:

I_CmsContextMenuEntry.isVisible()