org.opencms.workplace.list
Class CmsListExplorerDirectAction

java.lang.Object
  extended byorg.opencms.workplace.tools.A_CmsHtmlIconButton
      extended byorg.opencms.workplace.list.A_CmsListAction
          extended byorg.opencms.workplace.list.CmsListDirectAction
              extended byorg.opencms.workplace.list.CmsListExplorerDirectAction
All Implemented Interfaces:
I_CmsHtmlIconButton, I_CmsListAction, I_CmsListDirectAction
Direct Known Subclasses:
CmsListResourceLockAction, CmsListResourceProjStateAction, CmsListResourceTypeIconAction

public class CmsListExplorerDirectAction
extends CmsListDirectAction

Displays a 16x16 icon from the explorer view in a list action.

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

Field Summary
 
Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton
EMPTY_MESSAGE, m_id
 
Constructor Summary
CmsListExplorerDirectAction(java.lang.String id)
          Default Constructor.
 
Method Summary
 java.lang.String buttonHtml(CmsWorkplace wp)
          Returns the necessary html code.
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.
protected  CmsResourceUtil getResourceUtil()
          Returns the current result Util.
 void setItem(CmsListItem item)
          Sets the current item, should be called before the buttonHtml(org.opencms.workplace.CmsWorkplace) method.
 
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, getHelpText, getIconPath, getId, getName, 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
getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
 

Constructor Detail

CmsListExplorerDirectAction

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

Parameters:
id - the unique id
Method Detail

buttonHtml

public java.lang.String buttonHtml(CmsWorkplace wp)
Description copied from interface: I_CmsHtmlIconButton
Returns the necessary html code.

Specified by:
buttonHtml in interface I_CmsHtmlIconButton
Overrides:
buttonHtml in class CmsListDirectAction
See Also:
CmsListDirectAction.buttonHtml(org.opencms.workplace.CmsWorkplace)

setItem

public void setItem(CmsListItem item)
Description copied from interface: I_CmsListDirectAction
Sets the current item, should be called before the I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace) method.

Specified by:
setItem in interface I_CmsListDirectAction
Overrides:
setItem in class CmsListDirectAction
See Also:
I_CmsListDirectAction.setItem(org.opencms.workplace.list.CmsListItem)

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)
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.

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
onClick - the js code to execute, if empty no link is generated
confirmationMessage - the confirmation message
singleHelp - if set, no helptext is written, you have to use the defaultHelpHtml() method later
Returns:
html code
See Also:
A_CmsHtmlIconButton.defaultButtonHtml(org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String)

getResourceUtil

protected CmsResourceUtil getResourceUtil()
Returns the current result Util.

Returns:
the current result Util