Package io.jmix.ui.component.impl

Class DataLoadCoordinatorImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.DataLoadCoordinatorImpl

All Implemented Interfaces:

DataLoadCoordinator, Facet

public class DataLoadCoordinatorImpl
extends AbstractFacet
implements DataLoadCoordinator

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.DataLoadCoordinator

DataLoadCoordinator.LikeClause, DataLoadCoordinator.Trigger

Field Summary

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Fields inherited from interface io.jmix.ui.component.DataLoadCoordinator

DEFAULT_COMPONENT_PREFIX, DEFAULT_CONTAINER_PREFIX

Constructor Summary

Constructors

Constructor	Description
DataLoadCoordinatorImpl(UiControllerReflectionInspector reflectionInspector, QueryParamValuesManager queryParamValuesManager)

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.
void	setOwner(Frame owner)	Sets owner frame (Window or Fragment) to the facet.

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, setId, unsubscribe

Methods inherited from class java.lang.Object

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

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

getId, getOwner, setId

Constructor Details

DataLoadCoordinatorImpl

public DataLoadCoordinatorImpl(UiControllerReflectionInspector reflectionInspector,
 QueryParamValuesManager queryParamValuesManager)

Method Details

setOwner

public void setOwner(@Nullable
 Frame owner)

Description copied from interface: Facet

Sets owner frame (Window or Fragment) to the facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - owner frame

setContainerPrefix

public void setContainerPrefix(String value)

Description copied from interface: DataLoadCoordinator

Sets parameter prefix to denote a data container.

Specified by:

setContainerPrefix in interface DataLoadCoordinator

setComponentPrefix

public void setComponentPrefix(String value)

Description copied from interface: DataLoadCoordinator

Sets parameter prefix to denote a visual component.

Specified by:

setComponentPrefix in interface DataLoadCoordinator

getTriggers

public List<DataLoadCoordinator.Trigger> getTriggers()

Description copied from interface: DataLoadCoordinator

Returns configured triggers.

Specified by:

getTriggers in interface DataLoadCoordinator

addOnFrameOwnerEventLoadTrigger

public void addOnFrameOwnerEventLoadTrigger(DataLoader loader,
 Class eventClass)

Description copied from interface: DataLoadCoordinator

Adds trigger on screen/fragment event.

Specified by:

addOnFrameOwnerEventLoadTrigger in interface DataLoadCoordinator

Parameters:

loader - loader

eventClass - event class

addOnContainerItemChangedLoadTrigger

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

Description copied from interface: DataLoadCoordinator

Adds trigger on data container ItemChangeEvent.

Specified by:

addOnContainerItemChangedLoadTrigger in interface DataLoadCoordinator

Parameters:

loader - loader

container - master data container

param - loader parameter

addOnComponentValueChangedLoadTrigger

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

Description copied from interface: DataLoadCoordinator

Adds trigger on visual component ValueChangeEvent.

Specified by:

addOnComponentValueChangedLoadTrigger in interface DataLoadCoordinator

Parameters:

loader - loader

component - component which must implement HasValue

param - loader parameter

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

configureAutomatically

public void configureAutomatically()

Description copied from interface: DataLoadCoordinator

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.

Specified by:

configureAutomatically in interface DataLoadCoordinator