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

Class EnumHeaderFilter<T,E extends Enum>

java.lang.Object

org.dominokit.domino.ui.datatable.plugins.filter.header.EnumHeaderFilter<T,E>

Type Parameters:

T - type of data table records

E - the enum type

All Implemented Interfaces:

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

public class EnumHeaderFilter<T,E extends Enum>
extends Object
implements ColumnHeaderFilterPlugin.HeaderFilter<T>

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

Constructor Summary

Constructors

Constructor and Description
EnumHeaderFilter(E[] values, String allLabel) Creates a filter from an array of enum values and a custom label for all option

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the header filter component value
static <T,E extends Enum> EnumHeaderFilter<T,E>	create(E[] values) Creates a filter from an array of enum values and default label ALL for all option
static <T,E extends Enum> EnumHeaderFilter<T,E>	create(E[] values, String allLabel) Creates a filter from an array of enum values and 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

EnumHeaderFilter

public EnumHeaderFilter(E[] values,
                        String allLabel)

Creates a filter from an array of enum values and a custom label for all option

Parameters:

values - Array of enum values

Method Detail

create

public static <T,E extends Enum> EnumHeaderFilter<T,E> create(E[] values)

Creates a filter from an array of enum values and default label ALL for all option

Type Parameters:

T - type of data table records

E - the enum type

Parameters:

values - Array of enum values

Returns:

new instance

create

public static <T,E extends Enum> EnumHeaderFilter<T,E> create(E[] values,
                                                              String allLabel)

Creates a filter from an array of enum values and a custom label for all option

Type Parameters:

T - type of data table records

E - the enum type

Parameters:

values - Array of enum values

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