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

Class TextHeaderFilter<T>

java.lang.Object

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

org.dominokit.domino.ui.datatable.plugins.filter.header.TextHeaderFilter<T>

Type Parameters:

T - type of data table records

All Implemented Interfaces:

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

public class TextHeaderFilter<T>
extends DelayedHeaderFilterInput<TextBox,T>

String column header filter component that is rendered as a TextBox component

Constructor Summary

Constructors

Constructor and Description
TextHeaderFilter() Default constructor
TextHeaderFilter(String placeholder) Create and instance with custom placeholder

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the header filter component value
static <T> TextHeaderFilter<T>	create() create a new instance
static <T> TextHeaderFilter<T>	create(String placeholder) creates a new instance with custom placeholder
protected TextBox	createValueBox()
protected elemental2.dom.HTMLInputElement	getInputElement()
TextBox	getTextBox()
protected FilterTypes	getType()
protected String	getValue()
protected boolean	isEmpty()

Methods inherited from class org.dominokit.domino.ui.datatable.plugins.filter.header.DelayedHeaderFilterInput

element, getField, init

Methods inherited from class java.lang.Object

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

Constructor Detail

TextHeaderFilter

public TextHeaderFilter()

Default constructor

TextHeaderFilter

public TextHeaderFilter(String placeholder)

Create and instance with custom placeholder

Parameters:

placeholder - String

Method Detail

create

public static <T> TextHeaderFilter<T> create()

create a new instance

create

public static <T> TextHeaderFilter<T> create(String placeholder)

creates a new instance with custom placeholder

Type Parameters:

T - type of the data table records

Parameters:

placeholder - String

Returns:

new instance

getInputElement

protected elemental2.dom.HTMLInputElement getInputElement()

Specified by:

getInputElement in class DelayedHeaderFilterInput<TextBox,T>

Returns:

the HTMLInputElement wrapped inside the ValueBox component

createValueBox

protected TextBox createValueBox()

Specified by:

createValueBox in class DelayedHeaderFilterInput<TextBox,T>

Returns:

a new instance of the wrapped component type

isEmpty

protected boolean isEmpty()

Specified by:

isEmpty in class DelayedHeaderFilterInput<TextBox,T>

Returns:

boolean, true if the wrapped component is empty

getValue

protected String getValue()

Specified by:

getValue in class DelayedHeaderFilterInput<TextBox,T>

Returns:

String value of the wrapped component

getTextBox

public TextBox getTextBox()

Returns:

the TextBox wrapped in this component

getType

protected FilterTypes getType()

Specified by:

getType in class DelayedHeaderFilterInput<TextBox,T>

Returns:

The type of the filter

clear

public void clear()

Clears the header filter component value

this will be called by the ColumnHeaderFilterPlugin