org.dominokit.domino.ui.datatable.plugins

Class HeaderBarPlugin.SearchTableAction<T>

java.lang.Object

org.dominokit.domino.ui.datatable.plugins.HeaderBarPlugin.SearchTableAction<T>

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, HeaderActionElement<T>

Enclosing class:

HeaderBarPlugin<T>

public static class HeaderBarPlugin.SearchTableAction<T>
extends Object
implements HeaderActionElement<T>

A predefined action to add a search box the data table

Constructor Summary

Constructors

Constructor and Description
SearchTableAction() creates a new instance

Method Summary

Modifier and Type	Method and Description
elemental2.dom.Node	asElement(DataTable<T> dataTable) initialize the element for this action
int	getAutoSearchDelay()
void	handleEvent(TableEvent event)
boolean	isAutoSearch()
HeaderBarPlugin.SearchTableAction<T>	setAutoSearch(boolean autoSearch) Enable/Disable auto search when enabled the search will triggered while the user is typing with a delay otherwise the search will only be triggered when the user click on search or press Enter
void	setAutoSearchDelay(int autoSearchDelayInMillies)
HeaderBarPlugin.SearchTableAction<T>	setClearSearchToolTip(String clearSearchToolTip) Set the clear search icon tooltip
HeaderBarPlugin.SearchTableAction<T>	setSearchToolTip(String searchToolTip) Set the search icon tooltip

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTableAction

public SearchTableAction()

creates a new instance

Method Detail

isAutoSearch

public boolean isAutoSearch()

Returns:

boolean, true if the auto search is enabled

setAutoSearch

public HeaderBarPlugin.SearchTableAction<T> setAutoSearch(boolean autoSearch)

Enable/Disable auto search when enabled the search will triggered while the user is typing with a delay otherwise the search will only be triggered when the user click on search or press Enter

Parameters:

autoSearch - boolean

Returns:

same action instance

getAutoSearchDelay

public int getAutoSearchDelay()

Returns:

int search delay in milliseconds

setAutoSearchDelay

public void setAutoSearchDelay(int autoSearchDelayInMillies)

Parameters:

autoSearchDelayInMillies - int auto search delay in milliseconds

handleEvent

public void handleEvent(TableEvent event)

Specified by:

handleEvent in interface TableEventListener

Specified by:

handleEvent in interface HeaderActionElement<T>

Parameters:

event - the TableEvent being received

asElement

public elemental2.dom.Node asElement(DataTable<T> dataTable)

initialize the element for this action

Specified by:

asElement in interface HeaderActionElement<T>

Parameters:

dataTable - the DataTable we are attaching the plugin to

Returns:

the Node representing this action element

setSearchToolTip

public HeaderBarPlugin.SearchTableAction<T> setSearchToolTip(String searchToolTip)

Set the search icon tooltip

Parameters:

searchToolTip - String

Returns:

same action instance

setClearSearchToolTip

public HeaderBarPlugin.SearchTableAction<T> setClearSearchToolTip(String clearSearchToolTip)

Set the clear search icon tooltip

Parameters:

clearSearchToolTip - String

Returns:

same action instance