org.opencms.workplace.list
Class A_CmsListAction

java.lang.Object
  org.opencms.workplace.tools.A_CmsHtmlIconButton
      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.16 $

Author:

Michael Moossen

Field Summary

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

EMPTY_MESSAGE, m_id

Constructor Summary

A_CmsListAction(String id)
Default Constructor.

Method Summary

static String	defaultConfirmationHtml(String confId, 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.
String	getListId() Returns the id of the associated list.
void	setConfirmationMessage(CmsMessageContainer confirmationMsg) Sets the confirmation message.
void	setListId(String listId) Sets the list id.

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(String id)

Default Constructor.

Parameters:

id - unique id

Method Detail

defaultConfirmationHtml

public static String defaultConfirmationHtml(String confId,
                                             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

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 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()

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(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)