org.dominokit.domino.ui.datatable.plugins.filter.header

Class DelayedHeaderFilterInput<B extends ValueBox,T>

java.lang.Object

org.dominokit.domino.ui.datatable.plugins.filter.header.DelayedHeaderFilterInput<B,T>

Type Parameters:

B - the type of the component that extends from ValueBox and is wrapped in the implementation

T - the type of the data table records

All Implemented Interfaces:

ColumnHeaderFilterPlugin.HeaderFilter<T>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Direct Known Subclasses:

DecimalHeaderFilter, DoubleHeaderFilter, FloatHeaderFilter, IntegerHeaderFilter, LongHeaderFilter, ShortHeaderFilter, TextHeaderFilter

public abstract class DelayedHeaderFilterInput<B extends ValueBox,T>
extends Object
implements ColumnHeaderFilterPlugin.HeaderFilter<T>

An abstract implementation of the ColumnHeaderFilterPlugin.HeaderFilter for text input based filters that add a delay for triggering the search while the user is typing

Constructor Summary

Constructors

Constructor and Description
DelayedHeaderFilterInput() A constructor that initialized with a default placeholder
DelayedHeaderFilterInput(String placeHolder) A constructor to specify a custom placeholder

Method Summary

Modifier and Type	Method and Description
protected abstract B	createValueBox()
elemental2.dom.HTMLElement	element()
B	getField()
protected abstract elemental2.dom.HTMLInputElement	getInputElement()
protected abstract FilterTypes	getType()
protected abstract String	getValue()
void	init(SearchContext<T> searchContext, ColumnConfig<T> columnConfig) Initializes the header filter with the data table search context and the column config to which the filter is being added
protected abstract boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.datatable.plugins.ColumnHeaderFilterPlugin.HeaderFilter

clear

Constructor Detail

DelayedHeaderFilterInput

public DelayedHeaderFilterInput()

A constructor that initialized with a default placeholder

Search

DelayedHeaderFilterInput

public DelayedHeaderFilterInput(String placeHolder)

A constructor to specify a custom placeholder

Parameters:

placeHolder - String

Method Detail

init

public void init(SearchContext<T> searchContext,
                 ColumnConfig<T> columnConfig)

Initializes the header filter with the data table search context and the column config to which the filter is being added

this will be called by the ColumnHeaderFilterPlugin

Specified by:

init in interface ColumnHeaderFilterPlugin.HeaderFilter<T>

Parameters:

searchContext - SearchContext

columnConfig - ColumnConfig

getInputElement

protected abstract elemental2.dom.HTMLInputElement getInputElement()

Returns:

the HTMLInputElement wrapped inside the ValueBox component

createValueBox

protected abstract B createValueBox()

Returns:

a new instance of the wrapped component type

isEmpty

protected abstract boolean isEmpty()

Returns:

boolean, true if the wrapped component is empty

getValue

protected abstract String getValue()

Returns:

String value of the wrapped component

getType

protected abstract FilterTypes getType()

Returns:

The type of the filter

getField

public B getField()

Returns:

the wrapped component instance

element

public elemental2.dom.HTMLElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>