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.7 $
Author:
Michael Moossen

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

Method Detail

buttonHtml

public java.lang.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 java.lang.String getIconPath()
Returns the path to the icon.

Returns:
the path to the icon

getId

public java.lang.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

isVisible

public boolean isVisible()
Returns if visible or not.

Returns:
if visible or not

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(java.lang.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

setVisible

public void setVisible(boolean visible)
Sets if visible or not.

Parameters:
visible - if visible or not