Package org.opencms.workplace.list

Class CmsListResourceTypeIconAction

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

org.opencms.workplace.list.CmsListResourceTypeIconAction

All Implemented Interfaces:

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

public class CmsListResourceTypeIconAction
extends CmsListExplorerDirectAction

Displays an icon action for the resource type.

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
CmsListResourceTypeIconAction(String id)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
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.
org.opencms.i18n.CmsMessageContainer	getHelpText()
String	getIconPath()
org.opencms.i18n.CmsMessageContainer	getName()

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.tools.I_CmsHtmlIconButton

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

CmsListResourceTypeIconAction

public CmsListResourceTypeIconAction(String id)

Default Constructor.

Parameters:

id - the unique id

Method Details

getHelpText

public org.opencms.i18n.CmsMessageContainer getHelpText()

Specified by:

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

Overrides:

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

See Also:

• I_CmsHtmlIconButton.getHelpText()

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

getName

public org.opencms.i18n.CmsMessageContainer getName()

Specified by:

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

Overrides:

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

See Also:

• I_CmsHtmlIconButton.getName()

defButtonHtml

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