A_CmsListDirectJsAction (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.A_CmsListDirectJsAction

All Implemented Interfaces:

I_CmsListAction, I_CmsListDirectAction, org.opencms.workplace.tools.I_CmsHtmlIconButton
```
public abstract class A_CmsListDirectJsAction
extends CmsListDirectAction
```
Default implementation of a direct action for a html list column that can execute java script code.

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_CmsListDirectJsAction(java.lang.String id)
Default Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`jsCode()`	The js code to execute.
`protected java.lang.String`	`resolveOnClic(java.util.Locale locale)`	Help method to resolve the on clic text to use.

Methods inherited from class org.opencms.workplace.list.CmsListDirectAction
buttonHtml, confirmationTextHtml, getColumnForTexts, getItem, helpTextHtml, resolveButtonStyle, resolveHelpText, resolveName, 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
  - A_CmsListDirectJsAction
```
public A_CmsListDirectJsAction(java.lang.String id)
```
    Default Constructor.
    
    Parameters:
    
    id - unique id
- Method Detail
  - resolveOnClic
```
protected java.lang.String resolveOnClic(java.util.Locale locale)
```
    Description copied from class: CmsListDirectAction
    
    Help method to resolve the on clic text to use.
    
    Overrides:
    
    resolveOnClic in class CmsListDirectAction
    
    Parameters:
    
    locale - the used locale
    
    Returns:
    
    the on clic text
    
    See Also:
    
    CmsListDirectAction.resolveOnClic(java.util.Locale)
  - jsCode
```
public abstract java.lang.String jsCode()
```
    The js code to execute.
    
    Returns:
    
    js code to execute