Package io.jmix.flowui.component.grid.headerfilter

Class DataGridHeaderFilter

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.HorizontalLayout>

io.jmix.flowui.component.grid.headerfilter.DataGridHeaderFilter

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class DataGridHeaderFilter
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.HorizontalLayout>
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

A UI component used for displaying the filter in the column header. Modifies the standard header by adding a button to open a pop-up overlay with a PropertyFilter.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataGridHeaderFilter.ApplyEvent	An event fires when the current value of the PropertyFilter is applied to the loader.
static class	DataGridHeaderFilter.HeaderFilterContext

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected PropertyFilter.Operation	appliedOperation
protected Object	appliedValue
static final String	ATTRIBUTE_JMIX_ROLE_NAME
static final String	COLUMN_FILTER_BUTTON_ACTIVATED_ATTRIBUTE_NAME
static final String	COLUMN_FILTER_BUTTON_ROLE
static final String	COLUMN_FILTER_DIALOG_CLASSNAME
static final String	COLUMN_FILTER_FOOTER_SMALL_CLASSNAME
static final String	COLUMN_FILTER_POPUP_CLASSNAME
protected DataGridHeaderFilter.HeaderFilterContext	context
protected JmixButton	filterButton
protected com.vaadin.flow.component.Component	headerComponent
protected Messages	messages
protected com.vaadin.flow.component.dialog.Dialog	overlay
protected PropertyFilter	propertyFilter
protected PropertyFilterSupport	propertyFilterSupport
protected UiComponents	uiComponents

Constructor Summary

Constructors

Constructor	Description
DataGridHeaderFilter(DataGridHeaderFilter.HeaderFilterContext context)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addApplyListener(com.vaadin.flow.component.ComponentEventListener<DataGridHeaderFilter.ApplyEvent> eventListener)
void	afterPropertiesSet()
void	apply()	Applies the current value of the PropertyFilter to the loader
protected void	autowireDependencies()
protected JmixButton	createApplyButton()
protected JmixButton	createCancelButton()
protected JmixButton	createClearFilterButton()
protected void	doCancel()
com.vaadin.flow.component.Component	getHeader()
protected String	getOverlayPositionExpression()
PropertyFilter<?>	getPropertyFilter()
protected void	initComponent()
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	initContent()
protected void	initFunnelButton()
protected void	initOverlay()
protected void	initPropertyFilter()
boolean	isFilterApplied()
protected boolean	isSmallDevice()
protected void	onApplyButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
protected void	onCancelButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
protected void	onClearButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
protected void	onFilterButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
protected void	onOpenOverlay(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent event)
protected void	onOverlayClose(com.vaadin.flow.component.dialog.Dialog.DialogCloseActionEvent event)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setHeader(com.vaadin.flow.component.Component headerComponent)	Sets a component to be displayed next to the filter button.
void	setHeader(String labelText)	Sets a text to be displayed next to the filter button.
protected void	setupButtonFlexGrowStyle(JmixButton button)

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

ATTRIBUTE_JMIX_ROLE_NAME

public static final String ATTRIBUTE_JMIX_ROLE_NAME

See Also:

• Constant Field Values

COLUMN_FILTER_BUTTON_ROLE

public static final String COLUMN_FILTER_BUTTON_ROLE

See Also:

• Constant Field Values

COLUMN_FILTER_POPUP_CLASSNAME

public static final String COLUMN_FILTER_POPUP_CLASSNAME

See Also:

• Constant Field Values

COLUMN_FILTER_DIALOG_CLASSNAME

public static final String COLUMN_FILTER_DIALOG_CLASSNAME

See Also:

• Constant Field Values

COLUMN_FILTER_FOOTER_SMALL_CLASSNAME

public static final String COLUMN_FILTER_FOOTER_SMALL_CLASSNAME

See Also:

• Constant Field Values

COLUMN_FILTER_BUTTON_ACTIVATED_ATTRIBUTE_NAME

public static final String COLUMN_FILTER_BUTTON_ACTIVATED_ATTRIBUTE_NAME

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

uiComponents

protected UiComponents uiComponents

messages

protected Messages messages

propertyFilterSupport

protected PropertyFilterSupport propertyFilterSupport

context

protected DataGridHeaderFilter.HeaderFilterContext context

filterButton

protected JmixButton filterButton

overlay

protected com.vaadin.flow.component.dialog.Dialog overlay

propertyFilter

protected PropertyFilter propertyFilter

headerComponent

protected com.vaadin.flow.component.Component headerComponent

appliedValue

protected Object appliedValue

appliedOperation

protected PropertyFilter.Operation appliedOperation

Constructor Details

DataGridHeaderFilter

public DataGridHeaderFilter(DataGridHeaderFilter.HeaderFilterContext context)

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

autowireDependencies

protected void autowireDependencies()

initComponent

protected void initComponent()

initContent

protected com.vaadin.flow.component.orderedlayout.HorizontalLayout initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.HorizontalLayout>

setHeader

public void setHeader(String labelText)

Sets a text to be displayed next to the filter button.

Parameters:

labelText - the text to be shown

setHeader

public void setHeader(com.vaadin.flow.component.Component headerComponent)

Sets a component to be displayed next to the filter button.

Parameters:

headerComponent - the component to be shown

getHeader

@Nullable
public com.vaadin.flow.component.Component getHeader()

Returns:

the column header component except the filter button

getPropertyFilter

public PropertyFilter<?> getPropertyFilter()

Returns:

PropertyFilter witch is displayed in the overlay

isFilterApplied

public boolean isFilterApplied()

Returns:

true if the PropertyFilter component is applied to the DataLoader, false otherwise

initFunnelButton

protected void initFunnelButton()

onFilterButtonClick

protected void onFilterButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

initOverlay

protected void initOverlay()

initPropertyFilter

protected void initPropertyFilter()

onOpenOverlay

protected void onOpenOverlay(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent event)

onOverlayClose

protected void onOverlayClose(com.vaadin.flow.component.dialog.Dialog.DialogCloseActionEvent event)

createApplyButton

protected JmixButton createApplyButton()

onApplyButtonClick

protected void onApplyButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

createCancelButton

protected JmixButton createCancelButton()

onCancelButtonClick

protected void onCancelButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

setupButtonFlexGrowStyle

protected void setupButtonFlexGrowStyle(JmixButton button)

apply

public void apply()

Applies the current value of the PropertyFilter to the loader

doCancel

protected void doCancel()

createClearFilterButton

protected JmixButton createClearFilterButton()

onClearButtonClick

protected void onClearButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

getOverlayPositionExpression

protected String getOverlayPositionExpression()

isSmallDevice

protected boolean isSmallDevice()

addApplyListener

public com.vaadin.flow.shared.Registration addApplyListener(com.vaadin.flow.component.ComponentEventListener<DataGridHeaderFilter.ApplyEvent> eventListener)