org.opencms.workplace.list
Class 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
                  org.opencms.workplace.list.CmsListSearchAction

All Implemented Interfaces:

I_CmsHtmlIconButton, I_CmsListAction, I_CmsSearchMethod

public class CmsListSearchAction

extends A_CmsListSearchAction

implements I_CmsSearchMethod

Default implementation for a seach action in an html list.

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

Since:

6.0.0

Version:

$Revision: 1.12 $

Author:

Michael Moossen

Field Summary

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

LIST_ACTION_PRINT

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.
String	buttonHtml(CmsWorkplace wp) Returns the necessary html code.
List	filter(List items, String filter) Returns a sublist of the given items, that match the filter string.

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

getShowAllAction, setShowAllAction, useDefaultShowAllAction

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

getDefaultPrintListAction

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

defaultConfirmationHtml, getConfirmationMessage, getListId, setConfirmationMessage, setListId

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

defaultButtonHtml, defaultButtonHtml, defaultHelpHtml, getHelpText, getIconPath, getId, getName, isEnabled, setEnabled, setHelpText, setIconPath, setName

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.list.I_CmsListAction

getConfirmationMessage, getListId, setConfirmationMessage, setListId

Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton

getHelpText, getIconPath, getId, getName, isEnabled, setEnabled, setHelpText, setIconPath, setName

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

buttonHtml

public 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

See Also:

A_CmsListSearchAction.buttonHtml(org.opencms.workplace.CmsWorkplace)

filter

public List filter(List items,
                   String filter)

Description copied from interface: I_CmsSearchMethod

Returns a sublist of the given items, that match the filter string.

Specified by:

filter in interface I_CmsSearchMethod

Parameters:

items - the items to filter

filter - the filter string

Returns:

the filtered sublist

See Also:

I_CmsSearchMethod.filter(java.util.List, java.lang.String)