org.opencms.workplace.list
Class CmsListResourceTypeIconAction

java.lang.Object
  extended by org.opencms.workplace.tools.A_CmsHtmlIconButton
      extended by org.opencms.workplace.list.A_CmsListAction
          extended by org.opencms.workplace.list.CmsListDirectAction
              extended by org.opencms.workplace.list.CmsListExplorerDirectAction
                  extended by org.opencms.workplace.list.CmsListResourceTypeIconAction
All Implemented Interfaces:
I_CmsListAction, I_CmsListDirectAction, I_CmsHtmlIconButton

public class CmsListResourceTypeIconAction
extends CmsListExplorerDirectAction

Displays an icon action for the resource type.

Since:
6.0.0
Version:
$Revision: 1.3 $
Author:
Michael Moossen

Field Summary
 
Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton
EMPTY_MESSAGE, m_id
 
Constructor Summary
CmsListResourceTypeIconAction(java.lang.String id)
          Default Constructor.
 
Method Summary
protected  java.lang.String defButtonHtml(java.lang.String id, java.lang.String helpId, java.lang.String name, java.lang.String helpText, boolean enabled, java.lang.String iconPath, java.lang.String confirmationMessage, java.lang.String onClick, boolean singleHelp)
          Generates a default html code where several buttons can have the same help text.
 CmsMessageContainer getHelpText()
          Returns the help text.
 java.lang.String getIconPath()
          Returns the path to the icon.
 CmsMessageContainer getName()
          Returns the display name.
 
Methods inherited from class org.opencms.workplace.list.CmsListExplorerDirectAction
buttonHtml, getResourceUtil, setItem
 
Methods inherited from class org.opencms.workplace.list.CmsListDirectAction
confirmationTextHtml, getColumnForTexts, getItem, helpTextHtml, resolveButtonStyle, resolveHelpText, resolveName, resolveOnClic, setColumnForTexts
 
Methods inherited from class org.opencms.workplace.list.A_CmsListAction
buttonHtml, defaultConfirmationHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp
 
Methods inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton
defaultButtonHtml, defaultButtonHtml, defaultHelpHtml, getId, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opencms.workplace.list.I_CmsListAction
buttonHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp
 
Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton
getId, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
 

Constructor Detail

CmsListResourceTypeIconAction

public CmsListResourceTypeIconAction(java.lang.String id)
Default Constructor.

Parameters:
id - the unique id
Method Detail

getHelpText

public CmsMessageContainer getHelpText()
Description copied from interface: I_CmsHtmlIconButton
Returns the help text.

Specified by:
getHelpText in interface I_CmsHtmlIconButton
Overrides:
getHelpText in class A_CmsHtmlIconButton
Returns:
the help text
See Also:
I_CmsHtmlIconButton.getHelpText()

getIconPath

public java.lang.String getIconPath()
Description copied from interface: I_CmsHtmlIconButton
Returns the path to the icon.

Specified by:
getIconPath in interface I_CmsHtmlIconButton
Overrides:
getIconPath in class A_CmsHtmlIconButton
Returns:
the path to the icon
See Also:
A_CmsHtmlIconButton.getIconPath()

getName

public CmsMessageContainer getName()
Description copied from interface: I_CmsHtmlIconButton
Returns the display name.

Specified by:
getName in interface I_CmsHtmlIconButton
Overrides:
getName in class A_CmsHtmlIconButton
Returns:
the display name
See Also:
I_CmsHtmlIconButton.getName()

defButtonHtml

protected java.lang.String defButtonHtml(java.lang.String id,
                                         java.lang.String helpId,
                                         java.lang.String name,
                                         java.lang.String helpText,
                                         boolean enabled,
                                         java.lang.String iconPath,
                                         java.lang.String confirmationMessage,
                                         java.lang.String onClick,
                                         boolean singleHelp)
Description copied from class: CmsListExplorerDirectAction
Generates a default html code where several buttons can have the same help text.

the only diff to A_CmsHtmlIconButton.defaultButtonHtml(org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String) is that the icons are 16x16.

Overrides:
defButtonHtml in class CmsListExplorerDirectAction
Parameters:
id - the id
helpId - the id of the helptext div tag
name - the name, if empty only the icon is displayed
helpText - the help text, if empty no mouse events are generated
enabled - if enabled or not, if not set be sure to take an according helptext
iconPath - the path to the icon, if empty only the name is displayed
confirmationMessage - the confirmation message
onClick - the js code to execute, if empty no link is generated
singleHelp - if set, no helptext is written, you have to use the defaultHelpHtml() method later
Returns:
html code
See Also:
CmsListExplorerDirectAction.defButtonHtml(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String, boolean)