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

Version:

$Revision: 1.2 $

Author:

Michael Moossen

Field Summary

Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton

EMPTY_MESSAGE, m_id

Constructor Summary

CmsListExplorerDirectAction(String id, A_CmsListExplorerDialog wp)
Default Constructor.

Method Summary

String	buttonHtml(CmsWorkplace wp) Returns the necessary html code.
protected String	defButtonHtml(CmsJspActionElement jsp, 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.
protected CmsResourceUtil	getResourceUtil() Returns the current result Util.
A_CmsListExplorerDialog	getWp() Returns used the dialog.
void	setItem(CmsListItem item) Sets the current item, should be called before the I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace) method.
void	setWp(A_CmsListExplorerDialog wp) Sets the workplace dialog.

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

defaultConfirmationHtml, getConfirmationMessage, getListId, setConfirmationMessage, setListId

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.list.I_CmsListAction

getConfirmationMessage, getListId, setConfirmationMessage, setListId

Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton

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

Constructor Detail

CmsListExplorerDirectAction

public CmsListExplorerDirectAction(String id,
                                   A_CmsListExplorerDialog wp)

Default Constructor.

Parameters:

id - the unique id

wp - the current workplace context

Method Detail

buttonHtml

public String buttonHtml(CmsWorkplace wp)

Description copied from interface: I_CmsHtmlIconButton

Returns the necessary html code.

Specified by:

buttonHtml in interface I_CmsHtmlIconButton

Overrides:

buttonHtml in class CmsListDirectAction

Parameters:

wp - the jsp page to write the code to

Returns:

html code

See Also:

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

getWp

public A_CmsListExplorerDialog getWp()

Returns used the dialog.

Returns:

the used dialog

setItem

public void setItem(CmsListItem item)

Description copied from interface: I_CmsListDirectAction

Sets the current item, should be called before the I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace) method.

Specified by:

setItem in interface I_CmsListDirectAction

Overrides:

setItem in class CmsListDirectAction

Parameters:

item - the item

See Also:

I_CmsListDirectAction.setItem(org.opencms.workplace.list.CmsListItem)

setWp

public void setWp(A_CmsListExplorerDialog wp)

Sets the workplace dialog.

Parameters:

wp - the workplace dialog

defButtonHtml

protected String defButtonHtml(CmsJspActionElement jsp,
                               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(CmsJspActionElement, org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String) is that the icons are 16x16.

Parameters:

jsp - 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(CmsJspActionElement, org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum, String, String, String, boolean, String, String, String)

getResourceUtil

protected CmsResourceUtil getResourceUtil()

Returns the current result Util.

Returns:

the current result Util