Package org.opencms.workplace.administration

Class CmsAdminMenuItem

java.lang.Object

org.opencms.workplace.administration.CmsAdminMenuItem

Direct Known Subclasses:

CmsAdminContextHelpMenuItem

public class CmsAdminMenuItem
extends Object

Html icon button implementation that generates the required html code for a menu item.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsAdminMenuItem(String id, String name, String iconPath, String link, String helpText, boolean enabled, String target)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
String	getHelpText()	Returns the help text.
String	getIconPath()	Returns the path to the icon.
String	getId()	Returns the dhtml unique id.
String	getLink()	Returns the link.
String	getName()	Returns the display name.
String	getTarget()	Returns the target.
boolean	isEnabled()	Returns if enabled or disabled.
String	itemHtml(org.opencms.workplace.CmsWorkplace wp)	Returns the necessary html code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsAdminMenuItem

public CmsAdminMenuItem(String id,
 String name,
 String iconPath,
 String link,
 String helpText,
 boolean enabled,
 String target)

Default Constructor.

Parameters:

id - a unique id

name - the name of the item

iconPath - the icon to display

link - the link to open when selected

helpText - the help text to display

enabled - if enabled or not

target - the target frame to open the link into

Method Details

getHelpText

public String getHelpText()

Returns the help text.

Returns:

the help text

getIconPath

public String getIconPath()

Returns the path to the icon.

Returns:

the path to the icon

getId

public String getId()

Returns the dhtml unique id.

Returns:

the dhtml unique id

getLink

public String getLink()

Returns the link.

Returns:

the link

getName

public String getName()

Returns the display name.

Returns:

the name

getTarget

public String getTarget()

Returns the target.

Returns:

the target

isEnabled

public boolean isEnabled()

Returns if enabled or disabled.

Returns:

if enabled or disabled

itemHtml

public String itemHtml(org.opencms.workplace.CmsWorkplace wp)

Returns the necessary html code.

Parameters:

wp - the workplace

Returns:

html code