CmsListItemSelectionAction (OpenCms Workplace Modules API, version 17.0)

java.lang.Object
- org.opencms.workplace.tools.A_CmsHtmlIconButton
- - org.opencms.workplace.list.A_CmsListAction
  - - org.opencms.workplace.list.CmsListDirectAction
    - - org.opencms.workplace.list.CmsListItemSelectionAction

All Implemented Interfaces:

I_CmsListAction, I_CmsListDirectAction, org.opencms.workplace.tools.I_CmsHtmlIconButton

Direct Known Subclasses:

CmsListItemSelectionCustomAction
```
public class CmsListItemSelectionAction
extends CmsListDirectAction
```
Default implementation of a list item selection 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

CmsListItemSelectionAction(java.lang.String id, java.lang.String multiActionId)
Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`buttonHtml(org.opencms.workplace.CmsWorkplace wp)`
`java.lang.String`	`getMultiActionId()`	Returns the id of the related multi Action.
`java.lang.String`	`getSelectedItemId()`	Returns the selected item Id.
`void`	`setSelectedItemId(java.lang.String selectedItemId)`	Sets the selected item Id.

Methods inherited from class org.opencms.workplace.list.CmsListDirectAction
confirmationTextHtml, getColumnForTexts, getItem, helpTextHtml, resolveButtonStyle, resolveHelpText, resolveName, resolveOnClic, setColumnForTexts, setItem

Methods inherited from class org.opencms.workplace.list.A_CmsListAction
buttonHtml, defaultConfirmationHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp

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
getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible

Methods inherited from interface org.opencms.workplace.list.I_CmsListAction
buttonHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage, setListId, setWp

- Constructor Detail
  - CmsListItemSelectionAction
```
public CmsListItemSelectionAction(java.lang.String id,
                                  java.lang.String multiActionId)
```
    Default Constructor.
    
    Parameters:
    
    id - the unique id
    
    multiActionId - the id of the related multi Action
- Method Detail
  - buttonHtml
```
public java.lang.String buttonHtml(org.opencms.workplace.CmsWorkplace wp)
```
    Specified by:
    
    buttonHtml in interface org.opencms.workplace.tools.I_CmsHtmlIconButton
    
    Overrides:
    
    buttonHtml in class CmsListDirectAction
    
    See Also:
    
    I_CmsHtmlIconButton.buttonHtml(CmsWorkplace)
  - getMultiActionId
```
public java.lang.String getMultiActionId()
```
    Returns the id of the related multi Action.
    
    Returns:
    
    the id of the related multi Action
  - getSelectedItemId
```
public java.lang.String getSelectedItemId()
```
    Returns the selected item Id.
    
    Returns:
    
    the selected item Id
  - setSelectedItemId
```
public void setSelectedItemId(java.lang.String selectedItemId)
```
    Sets the selected item Id.
    
    Parameters:
    
    selectedItemId - the selected item Id to set