Package org.opencms.workplace.list

Class CmsListDropdownAction

java.lang.Object

org.opencms.workplace.tools.A_CmsHtmlIconButton

org.opencms.workplace.list.A_CmsListAction

org.opencms.workplace.list.CmsListIndependentAction

org.opencms.workplace.list.CmsListDropdownAction

All Implemented Interfaces:

I_CmsListAction, org.opencms.workplace.tools.I_CmsHtmlIconButton

public class CmsListDropdownAction
extends CmsListIndependentAction

Independent action to switch the resource state filter.

Do not forget to add parameter evaluation code overwritting the A_CmsListDialog#getList() method, like in CmsProjectFilesDialog.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUFFIX_PARAM	parameter name suffix.

Fields inherited from class org.opencms.workplace.list.CmsListIndependentAction

ACTION_EXPLORER_SWITCH_ID

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

EMPTY_MESSAGE, m_id

Constructor Summary

Constructors

Constructor	Description
CmsListDropdownAction(String id)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
void	addItem(String id, org.opencms.i18n.CmsMessageContainer name)	Adds an item to be displayed in the drop-down list.
String	buttonHtml(org.opencms.workplace.CmsWorkplace wp)
String	getSelection()	Returns the selected item.
void	setSelection(String selection)	Sets the selected item.

Methods inherited from class org.opencms.workplace.list.CmsListIndependentAction

getDefaultExplorerSwitchAction, resolveOnClic

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

Field Details

SUFFIX_PARAM

public static final String SUFFIX_PARAM

parameter name suffix.

See Also:

• Constant Field Values

Constructor Details

CmsListDropdownAction

public CmsListDropdownAction(String id)

Default Constructor.

Parameters:

id - unique id

Method Details

addItem

public void addItem(String id,
 org.opencms.i18n.CmsMessageContainer name)

Adds an item to be displayed in the drop-down list.

Parameters:

id - the id of the item

name - the display name

buttonHtml

public String buttonHtml(org.opencms.workplace.CmsWorkplace wp)

Specified by:

buttonHtml in interface org.opencms.workplace.tools.I_CmsHtmlIconButton

Overrides:

buttonHtml in class CmsListIndependentAction

See Also:

• I_CmsHtmlIconButton.buttonHtml(org.opencms.workplace.CmsWorkplace)

getSelection

public String getSelection()

Returns the selected item.

Returns:

the selected item

setSelection

public void setSelection(String selection)

Sets the selected item.

Parameters:

selection - the selected item to set