org.opencms.workplace.list
Class CmsListMultiSearchAction

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
                      extended by org.opencms.workplace.list.CmsListMultiSearchAction
All Implemented Interfaces:
I_CmsListAction, I_CmsHtmlIconButton

public class CmsListMultiSearchAction
extends CmsListSearchAction

Displays an advanced search form over several columns.

Since:
7.6
Version:
$Revision: 1.7 $
Author:
Michael Moossen

Field Summary
static java.lang.String KEY_VAL_DELIM
          The string to delimit key and value.
static java.lang.String PARAM_DELIM
          The string to delimit each column-value pair.
static java.lang.String SEARCH_COL_INPUT_ID
          the html id prefix for the input element of the search bar.
 
Fields inherited from class org.opencms.workplace.list.CmsListSearchAction
SEARCH_BAR_INPUT_ID
 
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
CmsListMultiSearchAction(CmsListColumnDefinition column)
          Default constructor.
 
Method Summary
 java.lang.String barHtml(CmsWorkplace wp)
          Returns the html code for the search bar.
 java.util.List filter(java.util.List items, java.lang.String searchFilter)
          Returns a sublist of the given items, that match the given filter string.
 
Methods inherited from class org.opencms.workplace.list.CmsListSearchAction
addColumn, buttonHtml, getColumns, isCaseInSensitive, setCaseInSensitive, setSearchFilter, setWp
 
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

KEY_VAL_DELIM

public static final java.lang.String KEY_VAL_DELIM
The string to delimit key and value.

See Also:
Constant Field Values

PARAM_DELIM

public static final java.lang.String PARAM_DELIM
The string to delimit each column-value pair.

See Also:
Constant Field Values

SEARCH_COL_INPUT_ID

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

See Also:
Constant Field Values
Constructor Detail

CmsListMultiSearchAction

public CmsListMultiSearchAction(CmsListColumnDefinition column)
Default constructor.

Parameters:
column - the first column to search in
See Also:
CmsListSearchAction.addColumn(CmsListColumnDefinition)
Method Detail

barHtml

public java.lang.String barHtml(CmsWorkplace wp)
Description copied from class: CmsListSearchAction
Returns the html code for the search bar.

Overrides:
barHtml in class CmsListSearchAction
Parameters:
wp - the workplace context
Returns:
html code
See Also:
CmsListSearchAction.barHtml(org.opencms.workplace.CmsWorkplace)

filter

public java.util.List filter(java.util.List items,
                             java.lang.String searchFilter)
Description copied from class: CmsListSearchAction
Returns a sublist of the given items, that match the given filter string.

Overrides:
filter in class CmsListSearchAction
Parameters:
items - the items to filter
searchFilter - the string to filter
Returns:
the filtered sublist
See Also:
CmsListSearchAction.filter(java.util.List, java.lang.String)