org.opencms.workplace.tools
Interface I_CmsHtmlIconButton

All Known Subinterfaces:

I_CmsListAction, I_CmsListDirectAction, I_CmsSearchMethod

All Known Implementing Classes:

A_CmsHtmlIconButton, A_CmsListAction, CmsListDirectAction, CmsListSearchAction

public interface I_CmsHtmlIconButton

Interface for html buttons with icon.

Since:

6.0.0

Version:

$Revision: 1.5 $

Author:

Michael Moossen

Method Summary

String	buttonHtml(CmsWorkplace wp) Returns the necessary html code.
CmsMessageContainer	getHelpText() Returns the help text.
String	getIconPath() Returns the path to the icon.
String	getId() Returns the id of the html component.
CmsMessageContainer	getName() Returns the display name.
boolean	isEnabled() Returns if enabled or disabled.
void	setEnabled(boolean enabled) Sets if enabled or disabled.
void	setHelpText(CmsMessageContainer helpText) Sets the help Text.
void	setIconPath(String iconPath) Sets the icon Path.
void	setName(CmsMessageContainer name) Sets the name.

Method Detail

buttonHtml

public String buttonHtml(CmsWorkplace wp)

Returns the necessary html code.

Parameters:

wp - the jsp page to write the code to

Returns:

html code

getHelpText

public CmsMessageContainer 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 id of the html component.

Returns:

the id

getName

public CmsMessageContainer getName()

Returns the display name.

Returns:

the display name

isEnabled

public boolean isEnabled()

Returns if enabled or disabled.

Returns:

if enabled or disabled

setEnabled

public void setEnabled(boolean enabled)

Sets if enabled or disabled.

Parameters:

enabled - if enabled or disabled

setHelpText

public void setHelpText(CmsMessageContainer helpText)

Sets the help Text.

Parameters:

helpText - the help Text to set

setIconPath

public void setIconPath(String iconPath)

Sets the icon Path.

Parameters:

iconPath - the icon Path to set

setName

public void setName(CmsMessageContainer name)

Sets the name.

Parameters:

name - the name to set