Package io.jmix.flowui.facet.urlqueryparameters

Class AbstractUrlQueryParametersBinder

java.lang.Object

io.jmix.flowui.facet.urlqueryparameters.AbstractUrlQueryParametersBinder

All Implemented Interfaces:

UrlQueryParametersFacet.Binder

Direct Known Subclasses:

DataGridFilterUrlQueryParametersBinder, FullCalendarUrlQueryParametersBinder, GenericFilterUrlQueryParametersBinder, PaginationUrlQueryParametersBinder, PropertyFilterUrlQueryParametersBinder

public abstract class AbstractUrlQueryParametersBinder
extends Object
implements UrlQueryParametersFacet.Binder

An abstract class for binding a UI component with URL query parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	id

Constructor Summary

Constructors

Constructor	Description
AbstractUrlQueryParametersBinder()

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addUrlQueryParametersChangeListener(Consumer<UrlQueryParametersFacet.UrlQueryParametersChangeEvent> listener)	Adds UrlQueryParametersFacet.UrlQueryParametersChangeEvent listener.
protected void	fireQueryParametersChanged(UrlQueryParametersFacet.UrlQueryParametersChangeEvent event)
abstract com.vaadin.flow.component.Component	getComponent()	Returns the component associated with this binder.
protected EventBus	getEventBus()
String	getId()
void	setId(String id)	Sets the query parameters binder id.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.facet.UrlQueryParametersFacet.Binder

updateState

Field Details

id

protected String id

Constructor Details

AbstractUrlQueryParametersBinder

public AbstractUrlQueryParametersBinder()

Method Details

getId

@Nullable
public String getId()

Specified by:

getId in interface UrlQueryParametersFacet.Binder

Returns:

the query parameters binder id

setId

public void setId(@Nullable
 String id)

Description copied from interface: UrlQueryParametersFacet.Binder

Sets the query parameters binder id.

Specified by:

setId in interface UrlQueryParametersFacet.Binder

Parameters:

id - id to set

addUrlQueryParametersChangeListener

public com.vaadin.flow.shared.Registration addUrlQueryParametersChangeListener(Consumer<UrlQueryParametersFacet.UrlQueryParametersChangeEvent> listener)

Description copied from interface: UrlQueryParametersFacet.Binder

Adds UrlQueryParametersFacet.UrlQueryParametersChangeEvent listener.

Specified by:

addUrlQueryParametersChangeListener in interface UrlQueryParametersFacet.Binder

Parameters:

listener - the listener to add, not null

Returns:

a registration object that can be used for removing the listener.

fireQueryParametersChanged

protected void fireQueryParametersChanged(UrlQueryParametersFacet.UrlQueryParametersChangeEvent event)

getComponent

@Nullable
public abstract com.vaadin.flow.component.Component getComponent()

Returns the component associated with this binder.

Returns:

the component instance if available, or null if no component is associated

getEventBus

protected EventBus getEventBus()