Package io.jmix.flowui.facet

Interface UrlQueryParametersFacet.Binder

All Known Implementing Classes:
AbstractUrlQueryParametersBinder, DataGridFilterUrlQueryParametersBinder, GenericFilterUrlQueryParametersBinder, PaginationUrlQueryParametersBinder, PropertyFilterUrlQueryParametersBinder
Enclosing interface:
UrlQueryParametersFacet
public static interface UrlQueryParametersFacet.Binder
An interface to be implemented by an object that binds UI component with query parameters.

  • Method Details

    • getId

      @Nullable String getId()
      Returns:
      the query parameters binder id

    • setId

      void setId(@Nullable String id)
      Sets the query parameters binder id.
      Parameters:
      id - id to set

    • updateState

      void updateState(com.vaadin.flow.router.QueryParameters queryParameters)
      Informs query parameters binder that view query parameters has been changed.
      Parameters:
      queryParameters - a view query parameters

    • addUrlQueryParametersChangeListener

      com.vaadin.flow.shared.Registration addUrlQueryParametersChangeListener(Consumer<UrlQueryParametersFacet.UrlQueryParametersChangeEvent> listener)
      Adds UrlQueryParametersFacet.UrlQueryParametersChangeEvent listener.
      Parameters:
      listener - the listener to add, not null
      Returns:
      a registration object that can be used for removing the listener.