Package org.opencms.workplace.list

Class CmsListExplorerDirectAction

java.lang.Object

org.opencms.workplace.tools.A_CmsHtmlIconButton

org.opencms.workplace.list.A_CmsListAction

org.opencms.workplace.list.CmsListDirectAction

org.opencms.workplace.list.CmsListExplorerDirectAction

All Implemented Interfaces:

I_CmsListAction, I_CmsListDirectAction, org.opencms.workplace.tools.I_CmsHtmlIconButton

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

Field Summary

Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton

EMPTY_MESSAGE, m_id

Constructor Summary

Constructors

Constructor	Description
CmsListExplorerDirectAction(String id)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
String	buttonHtml(org.opencms.workplace.CmsWorkplace wp)
protected String	defButtonHtml(String id, String helpId, String name, String helpText, boolean enabled, String iconPath, String confirmationMessage, String onClick, boolean singleHelp)	Generates a default html code where several buttons can have the same help text.
protected org.opencms.workplace.explorer.CmsResourceUtil	getResourceUtil()	Returns the current result Util.
void	setItem(CmsListItem item)	Sets the current item, should be called before the I_CmsHtmlIconButton.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.tools.I_CmsHtmlIconButton

getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible

Methods inherited from interface org.opencms.workplace.list.I_CmsListAction

buttonHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp

Constructor Details

CmsListExplorerDirectAction

public CmsListExplorerDirectAction(String id)

Default Constructor.

Parameters:

id - the unique id

Method Details

buttonHtml

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

Specified by:

buttonHtml in interface org.opencms.workplace.tools.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

Parameters:

item - the item

See Also:

• I_CmsListDirectAction.setItem(org.opencms.workplace.list.CmsListItem)

defButtonHtml

protected String defButtonHtml(String id,
 String helpId,
 String name,
 String helpText,
 boolean enabled,
 String iconPath,
 String confirmationMessage,
 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

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:

• A_CmsHtmlIconButton.defaultButtonHtml(org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String)

getResourceUtil

protected org.opencms.workplace.explorer.CmsResourceUtil getResourceUtil()

Returns the current result Util.

Returns:

the current result Util