org.opencms.workplace.list

类 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

所有已实现的接口:

I_CmsListAction, I_CmsListDirectAction, I_CmsHtmlIconButton

直接已知子类:

CmsDependencyIconAction

public class CmsListResourceIconAction
extends CmsListDirectAction

Displays an icon action for dependency lists.

从以下版本开始:

6.0.0

字段概要

从类继承的字段 org.opencms.workplace.tools.A_CmsHtmlIconButton

EMPTY_MESSAGE, m_id

构造器概要

构造器

构造器和说明
CmsListResourceIconAction(java.lang.String id, java.lang.String resColumnTypeId, CmsObject cms) Default Constructor.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	buttonHtml(CmsWorkplace wp) Returns the necessary html code.
protected java.lang.String	defButtonHtml(CmsObject cms, 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.
CmsObject	getCms() Returns the cms context.
java.lang.String	getIconPath() Returns the path to the icon.

从类继承的方法 org.opencms.workplace.list.CmsListDirectAction

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

从类继承的方法 org.opencms.workplace.list.A_CmsListAction

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

从类继承的方法 org.opencms.workplace.tools.A_CmsHtmlIconButton

defaultButtonHtml, defaultButtonHtml, defaultHelpHtml, getHelpText, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.workplace.list.I_CmsListAction

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

从接口继承的方法 org.opencms.workplace.tools.I_CmsHtmlIconButton

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

构造器详细资料

CmsListResourceIconAction

public CmsListResourceIconAction(java.lang.String id,
                         java.lang.String resColumnTypeId,
                         CmsObject cms)

Default Constructor.

参数:

id - the unique id

resColumnTypeId - the id of the column with the resource type

cms - the cms context

方法详细资料

buttonHtml

public java.lang.String buttonHtml(CmsWorkplace wp)

从接口复制的说明: I_CmsHtmlIconButton

Returns the necessary html code.

指定者:

buttonHtml 在接口中 I_CmsHtmlIconButton

覆盖:

buttonHtml 在类中 CmsListDirectAction

参数:

wp - the jsp page to write the code to

返回:

html code

另请参阅:

CmsListDirectAction.buttonHtml(org.opencms.workplace.CmsWorkplace)

getCms

public CmsObject getCms()

Returns the cms context.

返回:

the cms context

getIconPath

public java.lang.String getIconPath()

从接口复制的说明: I_CmsHtmlIconButton

Returns the path to the icon.

指定者:

getIconPath 在接口中 I_CmsHtmlIconButton

覆盖:

getIconPath 在类中 A_CmsHtmlIconButton

返回:

the path to the icon

另请参阅:

A_CmsHtmlIconButton.getIconPath()

defButtonHtml

protected java.lang.String defButtonHtml(CmsObject cms,
                             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.

参数:

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

返回:

html code

另请参阅:

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