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
-
-
Constructor Summary
Constructors Constructor Description CmsListResourceIconAction(java.lang.String id, java.lang.String resColumnTypeId, org.opencms.file.CmsObject cms)
Default Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
buttonHtml(org.opencms.workplace.CmsWorkplace wp)
protected java.lang.String
defButtonHtml(org.opencms.file.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.org.opencms.file.CmsObject
getCms()
Returns the cms context.java.lang.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 Detail
-
CmsListResourceIconAction
public CmsListResourceIconAction(java.lang.String id, java.lang.String resColumnTypeId, org.opencms.file.CmsObject cms)
Default Constructor.- Parameters:
id
- the unique idresColumnTypeId
- the id of the column with the resource typecms
- the cms context
-
-
Method Detail
-
buttonHtml
public java.lang.String buttonHtml(org.opencms.workplace.CmsWorkplace wp)
- Specified by:
buttonHtml
in interfaceorg.opencms.workplace.tools.I_CmsHtmlIconButton
- Overrides:
buttonHtml
in classCmsListDirectAction
- 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 java.lang.String getIconPath()
- Specified by:
getIconPath
in interfaceorg.opencms.workplace.tools.I_CmsHtmlIconButton
- Overrides:
getIconPath
in classorg.opencms.workplace.tools.A_CmsHtmlIconButton
- See Also:
A_CmsHtmlIconButton.getIconPath()
-
defButtonHtml
protected java.lang.String defButtonHtml(org.opencms.file.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
is that the icons are 16x16.A_CmsHtmlIconButton.defaultButtonHtml(org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String)
- Parameters:
cms
- the cms context, can be nullid
- the idhelpId
- the id of the helptext div tagname
- the name, if empty only the icon is displayedhelpText
- the help text, if empty no mouse events are generatedenabled
- if enabled or not, if not set be sure to take an according helptexticonPath
- the path to the icon, if empty only the name is displayedonClick
- the js code to execute, if empty no link is generatedconfirmationMessage
- the confirmation messagesingleHelp
- 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)
-
-