Package io.jmix.flowui.facet

Interface UrlQueryParametersFacet

All Superinterfaces:

Facet, HasSubParts

All Known Implementing Classes:

NoopUrlQueryParametersFacetImpl, UrlQueryParametersFacetImpl

public interface UrlQueryParametersFacet
extends Facet, HasSubParts

Represents a facet that manages URL query parameters and provides the ability to bind these parameters to UI components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UrlQueryParametersFacet.Binder	An interface to be implemented by an object that binds UI component with query parameters.
static class	UrlQueryParametersFacet.UrlQueryParametersChangeEvent	An event which is fired when a query parameters binder informs that its internal state has been changed and it should be reflected on URL's query parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Method Summary

Modifier and Type	Method	Description
List<UrlQueryParametersFacet.Binder>	getBinders()
void	registerBinder(UrlQueryParametersFacet.Binder binder)	Register a new query parameters binder.

Methods inherited from interface io.jmix.flowui.facet.Facet

getId, getOwner, setId, setOwner

Methods inherited from interface io.jmix.flowui.kit.component.HasSubParts

getSubPart

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

registerBinder

void registerBinder(UrlQueryParametersFacet.Binder binder)

Register a new query parameters binder.

Parameters:

binder - a binder instance to register

getBinders

List<UrlQueryParametersFacet.Binder> getBinders()

Returns:

a list of registered query parameter binders