Package org.opencms.workplace.list

Interface I_CmsListAction

All Superinterfaces:
org.opencms.workplace.tools.I_CmsHtmlIconButton
All Known Subinterfaces:
I_CmsListDirectAction
All Known Implementing Classes:
A_CmsListAction, A_CmsListDefaultJsAction, A_CmsListDirectJsAction, A_CmsListIndependentJsAction, A_CmsListSearchAction, CmsChangeLogLevelAction, CmsChangeLogLevelMultiAction, CmsDependencyIconAction, CmsGroupRemoveAction, CmsGroupStateAction, CmsListCsvExportIAction, CmsListDefaultAction, CmsListDirectAction, CmsListDropdownAction, CmsListEditResourceAction, CmsListExplorerDirectAction, CmsListIndependentAction, CmsListItemSelectionAction, CmsListItemSelectionCustomAction, CmsListMultiAction, CmsListMultiSearchAction, CmsListOpenResourceAction, CmsListPrintIAction, CmsListRadioMultiAction, CmsListResourceIconAction, CmsListResourceLockAction, CmsListResourceProjStateAction, CmsListResourceTypeIconAction, CmsListSearchAction, CmsRestoreStateAction
public interface I_CmsListAction extends org.opencms.workplace.tools.I_CmsHtmlIconButton
Interface for list actions.

Since:
6.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    buttonHtml()
    The same using getWp().
    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 interface org.opencms.workplace.tools.I_CmsHtmlIconButton

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

  • Method Details

    • buttonHtml

      String buttonHtml()
      The same using getWp().

      Returns:
      the buttons html code
      See Also:
      • I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace)

    • getConfirmationMessage

      org.opencms.i18n.CmsMessageContainer getConfirmationMessage()
      Returns an optional confirmation message for the action.

      It will be escaped for usage in java script code.

      Returns:
      confirmation message

    • getListId

      String getListId()
      Returns the id of the associated list.

      Returns:
      the id of the associated list

    • getWp

      A_CmsListDialog getWp()
      Returns the related workplace dialog object, to be able to access dynamic data.

      Returns:
      the related workplace dialog object

    • setConfirmationMessage

      void setConfirmationMessage(org.opencms.i18n.CmsMessageContainer confirmationMsg)
      Sets the confirmation message.

      Parameters:
      confirmationMsg - the confirmation message to set

    • setListId

      void setListId(String listId)
      Sets the list id.

      Parameters:
      listId - the id of the list to set

    • setWp

      void setWp(A_CmsListDialog wp)
      Sets the workplace dialog object.

      Parameters:
      wp - the workplace dialog object