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

Class BooleanHeaderFilter<T>

java.lang.Object

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

Type Parameters:

T - type of data table records

All Implemented Interfaces:

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

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

Boolean column header filter component that is rendered as a Select component

Constructor Summary

Constructors

Constructor and Description
BooleanHeaderFilter()
BooleanHeaderFilter(String trueLabel, String falseLabel, String bothLabel)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the header filter component value
static <T> BooleanHeaderFilter<T>	create() Creates an instance with default labels ALL,Yes,No
static <T> BooleanHeaderFilter<T>	create(String trueLabel, String falseLabel, String bothLabel) Creates an instance with specified labels
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

BooleanHeaderFilter

public BooleanHeaderFilter()

See Also:

create()

BooleanHeaderFilter

public BooleanHeaderFilter(String trueLabel,
                           String falseLabel,
                           String bothLabel)

Parameters:

trueLabel - String, the label for the Yes option

falseLabel - String, the label for the No option

bothLabel - String, the label for the ALL option

See Also:

create(String, String, String)

Method Detail

create

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

Creates an instance with default labels ALL,Yes,No

Type Parameters:

T - the data table records type

Returns:

new instance

create

public static <T> BooleanHeaderFilter<T> create(String trueLabel,
                                                String falseLabel,
                                                String bothLabel)

Creates an instance with specified labels

Type Parameters:

T - the data table records type

Parameters:

trueLabel - String, the label for the Yes option

falseLabel - String, the label for the No option

bothLabel - String, the label for the ALL option

Returns:

new instance

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 component wrapped in this filter