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
-
-
Constructor Summary
Constructors Constructor Description CmsListExplorerDirectAction(java.lang.String id)
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(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.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
method.I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace)
-
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 Detail
-
CmsListExplorerDirectAction
public CmsListExplorerDirectAction(java.lang.String id)
Default Constructor.- Parameters:
id
- the unique id
-
-
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)
-
setItem
public void setItem(CmsListItem item)
Description copied from interface:I_CmsListDirectAction
Sets the current item, should be called before the
method.I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace)
- Specified by:
setItem
in interfaceI_CmsListDirectAction
- Overrides:
setItem
in classCmsListDirectAction
- Parameters:
item
- the item- See Also:
I_CmsListDirectAction.setItem(org.opencms.workplace.list.CmsListItem)
-
defButtonHtml
protected java.lang.String defButtonHtml(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:
id
- 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)
-
getResourceUtil
protected org.opencms.workplace.explorer.CmsResourceUtil getResourceUtil()
Returns the current result Util.- Returns:
- the current result Util
-
-