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

Class SelectHeaderFilter<T>

java.lang.Object

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

All Implemented Interfaces:

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

public class SelectHeaderFilter<T>
extends Object
implements ColumnHeaderFilterPlugin.HeaderFilter<T>

A Single option select column header filter component that is rendered as a Select component * @param

Constructor Summary

Constructors

Constructor and Description
SelectHeaderFilter(String allLabel)

Method Summary

Modifier and Type	Method and Description
SelectHeaderFilter	appendChild(SelectOption<String> selectOption) adds a new option to the select
void	clear() Clears the header filter component value
static <T> SelectHeaderFilter<T>	create() create a new instance with a default label for ALL option
static <T> SelectHeaderFilter<T>	create(String allLabel) create a new instance with a custom label for ALL option
elemental2.dom.HTMLElement	element()
Select<String>	getSelect()
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

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectHeaderFilter

public SelectHeaderFilter(String allLabel)

Parameters:

allLabel - String, ALL option label

Method Detail

create

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

create a new instance with a default label for ALL option

create

public static <T> SelectHeaderFilter<T> create(String allLabel)

create a new instance with a custom label for ALL option

appendChild

public SelectHeaderFilter appendChild(SelectOption<String> selectOption)

adds a new option to the select

Parameters:

selectOption - the SelectOption

Returns:

same instance

See Also:

AbstractSelect.appendChild(SelectOption)

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

clear

public void clear()

Clears the header filter component value

this will be called by the ColumnHeaderFilterPlugin

Specified by:

clear in interface ColumnHeaderFilterPlugin.HeaderFilter<T>

element

public elemental2.dom.HTMLElement element()

Specified by:

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

getSelect

public Select<String> getSelect()

Returns:

the Select wrapped in this component