org.opencms.workplace.list

类 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

所有已实现的接口:

I_CmsListAction, I_CmsHtmlIconButton

直接已知子类:

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.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	SEARCH_BAR_INPUT_ID the html id for the input element of the search bar.

从类继承的字段 org.opencms.workplace.list.A_CmsListSearchAction

m_defaultShowAllAction, SEARCH_ACTION_ID, SHOWALL_ACTION_ID

从类继承的字段 org.opencms.workplace.list.CmsListIndependentAction

ACTION_EXPLORER_SWITCH_ID

从类继承的字段 org.opencms.workplace.tools.A_CmsHtmlIconButton

EMPTY_MESSAGE, m_id

构造器概要

构造器

构造器和说明
CmsListSearchAction(CmsListColumnDefinition column) Default Constructor.

方法概要

方法

限定符和类型	方法和说明
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<CmsListItem>	filter(java.util.List<CmsListItem> items, java.lang.String filter) Returns a sublist of the given items, that match the given filter string.
java.util.List<CmsListColumnDefinition>	getColumns() Returns the list of columns to be searched.
boolean	isCaseInSensitive() Returns the caseInSensitive.
void	setCaseInSensitive(boolean caseInSensitive) Sets the caseInSensitive.
void	setSearchFilter(java.lang.String filter) 已过时。 use CmsHtmlList.setSearchFilter(String) instead
void	setWp(A_CmsListDialog wp) Sets the workplace dialog object.

从类继承的方法 org.opencms.workplace.list.A_CmsListSearchAction

getShowAllAction, setListId, setShowAllAction, useDefaultShowAllAction

从类继承的方法 org.opencms.workplace.list.CmsListIndependentAction

getDefaultExplorerSwitchAction, resolveOnClic

从类继承的方法 org.opencms.workplace.list.A_CmsListAction

buttonHtml, defaultConfirmationHtml, getConfirmationMessage, getListId, getWp, setConfirmationMessage

从类继承的方法 org.opencms.workplace.tools.A_CmsHtmlIconButton

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

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.workplace.tools.I_CmsHtmlIconButton

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

字段详细资料

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.

另请参阅:

常量字段值

构造器详细资料

CmsListSearchAction

public CmsListSearchAction(CmsListColumnDefinition column)

Default Constructor.

参数:

column - the column to search into

方法详细资料

addColumn

public void addColumn(CmsListColumnDefinition column)

Adds a column to search into.

参数:

column - the additional column to search into

barHtml

public java.lang.String barHtml(CmsWorkplace wp)

Returns the html code for the search bar.

参数:

wp - the workplace context

返回:

html code

buttonHtml

public java.lang.String buttonHtml(CmsWorkplace wp)

从接口复制的说明: I_CmsHtmlIconButton

Returns the necessary html code.

指定者:

buttonHtml 在接口中 I_CmsHtmlIconButton

覆盖:

buttonHtml 在类中 A_CmsListSearchAction

参数:

wp - the jsp page to write the code to

返回:

html code

另请参阅:

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

filter

public java.util.List<CmsListItem> filter(java.util.List<CmsListItem> items,
                                 java.lang.String filter)

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

参数:

items - the items to filter

filter - the string to filter

返回:

the filtered sublist

getColumns

public java.util.List<CmsListColumnDefinition> getColumns()

Returns the list of columns to be searched.

返回:

a list of CmsListColumnDefinition objects

isCaseInSensitive

public boolean isCaseInSensitive()

Returns the caseInSensitive.

返回:

the caseInSensitive

setCaseInSensitive

public void setCaseInSensitive(boolean caseInSensitive)

Sets the caseInSensitive.

参数:

caseInSensitive - the caseInSensitive to set

setSearchFilter

@Deprecated
public void setSearchFilter(java.lang.String filter)

已过时。 use CmsHtmlList.setSearchFilter(String) instead

Sets the current search filter.

参数:

filter - the current search filter

setWp

public void setWp(A_CmsListDialog wp)

从接口复制的说明: I_CmsListAction

Sets the workplace dialog object.

指定者:

setWp 在接口中 I_CmsListAction

覆盖:

setWp 在类中 A_CmsListAction

参数:

wp - the workplace dialog object

另请参阅:

I_CmsListAction.setWp(org.opencms.workplace.list.A_CmsListDialog)