org.opencms.workplace.list
Class CmsListSearchAction

java.lang.Object
  extended by org.opencms.workplace.tools.A_CmsHtmlIconButton
      extended by org.opencms.workplace.list.A_CmsListAction
          extended by org.opencms.workplace.list.CmsListIndependentAction
              extended by org.opencms.workplace.list.A_CmsListSearchAction
                  extended by org.opencms.workplace.list.CmsListSearchAction
All Implemented Interfaces:
I_CmsListAction, I_CmsHtmlIconButton
Direct Known Subclasses:
CmsListMultiSearchAction

public class CmsListSearchAction
extends A_CmsListSearchAction

Default implementation for a search action in an html list.

It allows to search in several columns, including item details.

Since:
6.0.0
Version:
$Revision: 1.21 $
Author:
Michael Moossen

Field Summary
static java.lang.String SEARCH_BAR_INPUT_ID
          the html id for the input element of the search bar.
 
Fields inherited from class org.opencms.workplace.list.A_CmsListSearchAction
m_defaultShowAllAction, SEARCH_ACTION_ID, SHOWALL_ACTION_ID
 
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
CmsListSearchAction(CmsListColumnDefinition column)
          Default Constructor.
 
Method Summary
 void addColumn(CmsListColumnDefinition column)
          Adds a column to search into.
 java.lang.String barHtml(CmsWorkplace wp)
          Returns the html code for the search bar.
 java.lang.String buttonHtml(CmsWorkplace wp)
          Returns the necessary html code.
 java.util.List filter(java.util.List items, java.lang.String filter)
          Returns a sublist of the given items, that match the given filter string.
 java.util.List getColumns()
          Returns the list of columns to be searched.
 void setSearchFilter(java.lang.String filter)
          Deprecated. use CmsHtmlList.setSearchFilter(String) instead
 void setWp(A_CmsListDialog wp)
          Sets the workplace dialog object.
 
Methods inherited from class org.opencms.workplace.list.A_CmsListSearchAction
getShowAllAction, setListId, setShowAllAction, useDefaultShowAllAction
 
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
 
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 Detail

SEARCH_BAR_INPUT_ID

public static final java.lang.String SEARCH_BAR_INPUT_ID
the html id for the input element of the search bar.

See Also:
Constant Field Values
Constructor Detail

CmsListSearchAction

public CmsListSearchAction(CmsListColumnDefinition column)
Default Constructor.

Parameters:
column - the column to search into
Method Detail

addColumn

public void addColumn(CmsListColumnDefinition column)
Adds a column to search into.

Parameters:
column - the additional column to search into

barHtml

public java.lang.String barHtml(CmsWorkplace wp)
Returns the html code for the search bar.

Parameters:
wp - the workplace context
Returns:
html code

buttonHtml

public java.lang.String buttonHtml(CmsWorkplace wp)
Description copied from interface: I_CmsHtmlIconButton
Returns the necessary html code.

Specified by:
buttonHtml in interface I_CmsHtmlIconButton
Overrides:
buttonHtml in class A_CmsListSearchAction
Parameters:
wp - the jsp page to write the code to
Returns:
html code
See Also:
A_CmsListSearchAction.buttonHtml(org.opencms.workplace.CmsWorkplace)

filter

public java.util.List filter(java.util.List items,
                             java.lang.String filter)
Returns a sublist of the given items, that match the given filter string.

Parameters:
items - the items to filter
filter - the string to filter
Returns:
the filtered sublist

getColumns

public java.util.List getColumns()
Returns the list of columns to be searched.

Returns:
a list of CmsListColumnDefinition objects

setSearchFilter

public void setSearchFilter(java.lang.String filter)
Deprecated. use CmsHtmlList.setSearchFilter(String) instead

Sets the current search filter.

Parameters:
filter - the current search filter

setWp

public void setWp(A_CmsListDialog wp)
Description copied from interface: I_CmsListAction
Sets the workplace dialog object.

Specified by:
setWp in interface I_CmsListAction
Overrides:
setWp in class A_CmsListAction
Parameters:
wp - the workplace dialog object
See Also:
I_CmsListAction.setWp(org.opencms.workplace.list.A_CmsListDialog)