org.opencms.workplace.list
Class A_CmsListAction

java.lang.Object
  extended by org.opencms.workplace.tools.A_CmsHtmlIconButton
      extended by org.opencms.workplace.list.A_CmsListAction
All Implemented Interfaces:
I_CmsListAction, I_CmsHtmlIconButton
Direct Known Subclasses:
CmsListDirectAction, CmsListIndependentAction, CmsListMultiAction

public abstract class A_CmsListAction
extends A_CmsHtmlIconButton
implements I_CmsListAction

The default skeleton for a list action.

Since:
6.0.0
Version:
$Revision: 1.22 $
Author:
Michael Moossen

Field Summary
 
Fields inherited from class org.opencms.workplace.tools.A_CmsHtmlIconButton
EMPTY_MESSAGE, m_id
 
Constructor Summary
A_CmsListAction(java.lang.String id)
          Default Constructor.
 
Method Summary
 java.lang.String buttonHtml()
          The same using I_CmsListAction.getWp().
static java.lang.String defaultConfirmationHtml(java.lang.String confId, java.lang.String confText)
          Generates html for the confirmation message when having one confirmation message for several actions.
 CmsMessageContainer getConfirmationMessage()
          Returns an optional confirmation message for the action.
 java.lang.String getListId()
          Returns the id of the associated list.
 A_CmsListDialog getWp()
          Returns the related workplace dialog object, to be able to access dynamic data.
 void setConfirmationMessage(CmsMessageContainer confirmationMsg)
          Sets the confirmation message.
 void setListId(java.lang.String listId)
          Sets the list id.
 void setWp(A_CmsListDialog wp)
          Sets the workplace dialog object.
 
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
buttonHtml, getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
 

Constructor Detail

A_CmsListAction

public A_CmsListAction(java.lang.String id)
Default Constructor.

Parameters:
id - unique id
Method Detail

defaultConfirmationHtml

public static java.lang.String defaultConfirmationHtml(java.lang.String confId,
                                                       java.lang.String confText)
Generates html for the confirmation message when having one confirmation message for several actions.

Parameters:
confId - the id of the confirmation message
confText - the confirmation message
Returns:
html code

buttonHtml

public java.lang.String buttonHtml()
Description copied from interface: I_CmsListAction
The same using I_CmsListAction.getWp().

Specified by:
buttonHtml in interface I_CmsListAction
Returns:
the buttons html code
See Also:
I_CmsListAction.buttonHtml()

getConfirmationMessage

public CmsMessageContainer getConfirmationMessage()
Description copied from interface: I_CmsListAction
Returns an optional confirmation message for the action.

It will be escaped for usage in java script code.

Specified by:
getConfirmationMessage in interface I_CmsListAction
Returns:
confirmation message
See Also:
I_CmsListAction.getConfirmationMessage()

getListId

public java.lang.String getListId()
Description copied from interface: I_CmsListAction
Returns the id of the associated list.

Specified by:
getListId in interface I_CmsListAction
Returns:
the id of the associated list
See Also:
I_CmsListAction.getListId()

getWp

public A_CmsListDialog getWp()
Description copied from interface: I_CmsListAction
Returns the related workplace dialog object, to be able to access dynamic data.

Specified by:
getWp in interface I_CmsListAction
Returns:
the related workplace dialog object
See Also:
I_CmsListAction.getWp()

setConfirmationMessage

public void setConfirmationMessage(CmsMessageContainer confirmationMsg)
Description copied from interface: I_CmsListAction
Sets the confirmation message.

Specified by:
setConfirmationMessage in interface I_CmsListAction
Parameters:
confirmationMsg - the confirmation message to set
See Also:
I_CmsListAction.setConfirmationMessage(org.opencms.i18n.CmsMessageContainer)

setListId

public void setListId(java.lang.String listId)
Description copied from interface: I_CmsListAction
Sets the list id.

Specified by:
setListId in interface I_CmsListAction
Parameters:
listId - the id of the list to set
See Also:
I_CmsListAction.setListId(java.lang.String)

setWp

public void setWp(A_CmsListDialog wp)
Description copied from interface: I_CmsListAction
Sets the workplace dialog object.

Specified by:
setWp in interface I_CmsListAction
Parameters:
wp - the workplace dialog object
See Also:
I_CmsListAction.setWp(org.opencms.workplace.list.A_CmsListDialog)