Package 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, org.opencms.workplace.tools.I_CmsHtmlIconButton
Direct Known Subclasses:
CmsListDirectAction, CmsListIndependentAction, CmsListMultiAction
public abstract class A_CmsListAction extends org.opencms.workplace.tools.A_CmsHtmlIconButton implements I_CmsListAction
The default skeleton for a list action.

Since:
6.0.0

  • Field Summary

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

    EMPTY_MESSAGE, m_id

  • Constructor Summary

    Constructors
    Constructor
    Description
    A_CmsListAction(String id)
    Default Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    buttonHtml()
    The same using I_CmsListAction.getWp().
    static String
    defaultConfirmationHtml(String confId, String confText)
    Generates html for the confirmation message when having one confirmation message for several actions.
    org.opencms.i18n.CmsMessageContainer
    getConfirmationMessage()
    Returns an optional confirmation message for the action.
    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(org.opencms.i18n.CmsMessageContainer confirmationMsg)
    Sets the confirmation message.
    void
    setListId(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