Package org.opencms.workplace.list

Class CmsListResourceIconAction

java.lang.Object

org.opencms.workplace.tools.A_CmsHtmlIconButton

org.opencms.workplace.list.A_CmsListAction

org.opencms.workplace.list.CmsListDirectAction

org.opencms.workplace.list.CmsListResourceIconAction

All Implemented Interfaces:

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

Direct Known Subclasses:

CmsDependencyIconAction

public class CmsListResourceIconAction
extends CmsListDirectAction

Displays an icon action for dependency lists.

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
CmsListResourceIconAction(String id, String resColumnTypeId, org.opencms.file.CmsObject cms)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
String	buttonHtml(org.opencms.workplace.CmsWorkplace wp)
protected String	defButtonHtml(org.opencms.file.CmsObject cms, 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.
org.opencms.file.CmsObject	getCms()	Returns the cms context.
String	getIconPath()

Methods inherited from class org.opencms.workplace.list.CmsListDirectAction

confirmationTextHtml, getColumnForTexts, getItem, helpTextHtml, resolveButtonStyle, resolveHelpText, resolveName, resolveOnClic, setColumnForTexts, setItem

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, 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, 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

CmsListResourceIconAction

public CmsListResourceIconAction(String id,
 String resColumnTypeId,
 org.opencms.file.CmsObject cms)

Default Constructor.

Parameters:

id - the unique id

resColumnTypeId - the id of the column with the resource type

cms - the cms context

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)

getCms

public org.opencms.file.CmsObject getCms()

Returns the cms context.

Returns:

the cms context

getIconPath

public String getIconPath()

Specified by:

getIconPath in interface org.opencms.workplace.tools.I_CmsHtmlIconButton

Overrides:

getIconPath in class org.opencms.workplace.tools.A_CmsHtmlIconButton

See Also:

• A_CmsHtmlIconButton.getIconPath()

defButtonHtml

protected String defButtonHtml(org.opencms.file.CmsObject cms,
 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:

cms - the cms context, can be null

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)