Package io.jmix.ui.component

Interface DataLoadCoordinator

All Superinterfaces:

Facet

All Known Implementing Classes:

DataLoadCoordinatorImpl

@StudioFacet(xmlElement="dataLoadCoordinator",
             caption="DataLoadCoordinator",
             category="Facets",
             description="Controls triggering of data loaders and provides support for automatic linking data loaders to data containers and visual components",
             defaultProperty="id",
             documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/facets/data-load-coordinator.html",
             icon="io/jmix/ui/icon/facet/dataLoadCoordinator.svg")
public interface DataLoadCoordinator
extends Facet

Controls triggering of data loaders and provides support for automatic linking data loaders to data containers and visual components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DataLoadCoordinator.LikeClause	Type of the LIKE clause.
static interface	DataLoadCoordinator.Trigger	Load trigger.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COMPONENT_PREFIX
static final String	DEFAULT_CONTAINER_PREFIX

Method Summary

Modifier and Type	Method	Description
void	addOnComponentValueChangedLoadTrigger(DataLoader loader, Component component, String param, DataLoadCoordinator.LikeClause likeClause)	Adds trigger on visual component ValueChangeEvent.
void	addOnContainerItemChangedLoadTrigger(DataLoader loader, InstanceContainer container, String param)	Adds trigger on data container ItemChangeEvent.
void	addOnFrameOwnerEventLoadTrigger(DataLoader loader, Class eventClass)	Adds trigger on screen/fragment event.
void	configureAutomatically()	Configures triggers automatically relying upon parameter prefixes.
List<DataLoadCoordinator.Trigger>	getTriggers()	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.

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId, setOwner

Field Details

DEFAULT_CONTAINER_PREFIX

static final String DEFAULT_CONTAINER_PREFIX

See Also:

• Constant Field Values

DEFAULT_COMPONENT_PREFIX

static final String DEFAULT_COMPONENT_PREFIX

See Also:

• Constant Field Values

Method Details

setContainerPrefix

@StudioProperty(name="containerPrefix",
                defaultValue="container_")
void setContainerPrefix(String value)

Sets parameter prefix to denote a data container.

setComponentPrefix

@StudioProperty(name="componentPrefix",
                defaultValue="component_")
void setComponentPrefix(String value)

Sets parameter prefix to denote a visual component.

addOnFrameOwnerEventLoadTrigger

void addOnFrameOwnerEventLoadTrigger(DataLoader loader,
 Class eventClass)

Adds trigger on screen/fragment event.

Parameters:

loader - loader

eventClass - event class

addOnContainerItemChangedLoadTrigger

void addOnContainerItemChangedLoadTrigger(DataLoader loader,
 InstanceContainer container,
 @Nullable
 String param)

Adds trigger on data container ItemChangeEvent.

Parameters:

loader - loader

container - master data container

param - loader parameter

addOnComponentValueChangedLoadTrigger

void addOnComponentValueChangedLoadTrigger(DataLoader loader,
 Component component,
 @Nullable
 String param,
 DataLoadCoordinator.LikeClause likeClause)

Adds trigger on visual component ValueChangeEvent.

Parameters:

loader - loader

component - component which must implement HasValue

param - loader parameter

likeClause - whether the condition using the parameter is a LIKE clause

configureAutomatically

@StudioProperty(name="auto",
                type=BOOLEAN,
                defaultValue="false",
                initialValue="true")
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 on BeforeShowEvent or AttachEvent.

getTriggers

@StudioElementsGroup(caption="Refresh",
                     xmlElement="refresh",
                     icon="io/jmix/ui/icon/facet/refresh.svg",
                     maxOccurs=UNBOUNDED)
List<DataLoadCoordinator.Trigger> getTriggers()

Returns configured triggers.