Package org.opencms.workplace.list
Class A_CmsListSearchAction
- java.lang.Object
-
- org.opencms.workplace.tools.A_CmsHtmlIconButton
-
- org.opencms.workplace.list.A_CmsListAction
-
- org.opencms.workplace.list.CmsListIndependentAction
-
- org.opencms.workplace.list.A_CmsListSearchAction
-
- All Implemented Interfaces:
I_CmsListAction
,org.opencms.workplace.tools.I_CmsHtmlIconButton
- Direct Known Subclasses:
CmsListSearchAction
public abstract class A_CmsListSearchAction extends CmsListIndependentAction
Abstract implementation of a search action.It provides the default show all action accessor and the rendering method.
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description I_CmsListAction
m_defaultShowAllAction
A default show all action.static java.lang.String
SEARCH_ACTION_ID
The action id for the search action.static java.lang.String
SHOWALL_ACTION_ID
The action id for the show all action.-
Fields inherited from class org.opencms.workplace.list.CmsListIndependentAction
ACTION_EXPLORER_SWITCH_ID
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
A_CmsListSearchAction()
Default Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
buttonHtml(org.opencms.workplace.CmsWorkplace wp)
I_CmsListAction
getShowAllAction()
Returns the Show-All action.void
setListId(java.lang.String listId)
Sets the list id.void
setShowAllAction(I_CmsListAction showAllAction)
Sets the Show-All action.void
useDefaultShowAllAction()
Sets the current used show-all action to the default.-
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, 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
-
-
-
-
Field Detail
-
SEARCH_ACTION_ID
public static final java.lang.String SEARCH_ACTION_ID
The action id for the search action.- See Also:
- Constant Field Values
-
SHOWALL_ACTION_ID
public static final java.lang.String SHOWALL_ACTION_ID
The action id for the show all action.- See Also:
- Constant Field Values
-
m_defaultShowAllAction
public final I_CmsListAction m_defaultShowAllAction
A default show all action.
-
-
Constructor Detail
-
A_CmsListSearchAction
protected A_CmsListSearchAction()
Default Constructor.
-
-
Method Detail
-
buttonHtml
public java.lang.String buttonHtml(org.opencms.workplace.CmsWorkplace wp)
- Specified by:
buttonHtml
in interfaceorg.opencms.workplace.tools.I_CmsHtmlIconButton
- Overrides:
buttonHtml
in classCmsListIndependentAction
- See Also:
I_CmsHtmlIconButton.buttonHtml(CmsWorkplace)
-
getShowAllAction
public I_CmsListAction getShowAllAction()
Returns the Show-All action.- Returns:
- the Show-All action
-
setListId
public void setListId(java.lang.String listId)
Description copied from interface:I_CmsListAction
Sets the list id.- Specified by:
setListId
in interfaceI_CmsListAction
- Overrides:
setListId
in classA_CmsListAction
- Parameters:
listId
- the id of the list to set- See Also:
A_CmsListAction.setListId(java.lang.String)
-
setShowAllAction
public void setShowAllAction(I_CmsListAction showAllAction)
Sets the Show-All action.- Parameters:
showAllAction
- the Show-All action to set
-
useDefaultShowAllAction
public void useDefaultShowAllAction()
Sets the current used show-all action to the default.
-
-