Package io.jmix.flowui.facet
Interface DataLoadCoordinator
- All Superinterfaces:
Facet
- All Known Implementing Classes:
DataLoadCoordinatorImpl
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
Type of the LIKE clause.static interface
Load trigger. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addOnComponentValueChangedLoadTrigger
(DataLoader loader, com.vaadin.flow.component.Component component, String param, DataLoadCoordinator.LikeClause likeClause) Adds trigger on visual componentValueChangeEvent
.void
addOnContainerItemChangedLoadTrigger
(DataLoader loader, InstanceContainer<?> container, String param) Adds trigger on data containerItemChangeEvent
.void
addOnViewEventLoadTrigger
(DataLoader loader, Class<?> eventClass) Adds trigger on view event.void
Configures triggers automatically relying upon parameter prefixes.Returns configured triggers.void
setComponentPrefix
(String value) Sets parameter prefix to denote a visual component.void
setContainerPrefix
(String value) Sets parameter prefix to denote a data container.
-
Field Details
-
NAME
- See Also:
-
DEFAULT_CONTAINER_PREFIX
- See Also:
-
DEFAULT_COMPONENT_PREFIX
- See Also:
-
-
Method Details
-
setContainerPrefix
Sets parameter prefix to denote a data container. -
setComponentPrefix
Sets parameter prefix to denote a visual component. -
addOnViewEventLoadTrigger
Adds trigger on view event.- Parameters:
loader
- loadereventClass
- event class
-
addOnContainerItemChangedLoadTrigger
void addOnContainerItemChangedLoadTrigger(DataLoader loader, InstanceContainer<?> container, @Nullable String param) Adds trigger on data containerItemChangeEvent
.- Parameters:
loader
- loadercontainer
- master data containerparam
- loader parameter
-
addOnComponentValueChangedLoadTrigger
void addOnComponentValueChangedLoadTrigger(DataLoader loader, com.vaadin.flow.component.Component component, @Nullable String param, DataLoadCoordinator.LikeClause likeClause) Adds trigger on visual componentValueChangeEvent
.- Parameters:
loader
- loadercomponent
- component which must implementHasValue
param
- loader parameterlikeClause
- whether the condition using the parameter is a LIKE clause
-
configureAutomatically
void configureAutomatically()Configures triggers automatically relying upon parameter prefixes. All data containers that don't have a prefixed parameter in the query string, are configured to be triggered onBeforeShowEvent
orAttachEvent
. -
getTriggers
List<DataLoadCoordinator.Trigger> getTriggers()Returns configured triggers.
-