org.kie.workbench.common.stunner.core.client.canvas

Class CanvasHandlerProxy<D extends Diagram,C extends AbstractCanvas>

java.lang.Object

org.kie.workbench.common.stunner.core.client.canvas.AbstractCanvasHandler<D,C>

org.kie.workbench.common.stunner.core.client.canvas.BaseCanvasHandler<D,C>

org.kie.workbench.common.stunner.core.client.canvas.CanvasHandlerProxy<D,C>

Type Parameters:

D - The diagram type.

C - The handled canvas type.

All Implemented Interfaces:

CanvasHandler<D,C>, HasCanvasListeners<CanvasElementListener>

public abstract class CanvasHandlerProxy<D extends Diagram,C extends AbstractCanvas>
extends BaseCanvasHandler<D,C>

It wraps a given AbstractCanvasHandler instance and replicates its state into this instance' canvas. By default it provides a null instance for the graph execution context and does not load rules, so no runtime evaluations neither model updates are applied by this handler. Eg: It's useful for preview goals - it can proxy a given handler and replicate its state on a differnt canvas instance.

Constructor Summary

Constructors

Constructor and Description
CanvasHandlerProxy(DefinitionManager definitionManager, GraphUtils graphUtils, ShapeManager shapeManager)

Method Summary

Modifier and Type	Method and Description
protected void	buildGraphIndex(org.uberfire.mvp.Command loadCallback) Build the graph index instance using any concrete index/builder types.
protected void	destroyGraphIndex(org.uberfire.mvp.Command callback) Destroys this instance' graph index.
GraphCommandExecutionContext	getGraphExecutionContext() Should return a graph execution context to perform the model updates applied by the graph command executions.
Index<?,?>	getGraphIndex() Returns the graph index instance to perform lookups over the graph structure foe this canvas handler's diagram instance loaded.
GraphRulesManager	getGraphRulesManager() Provides the graph rules manager instance for this context.
ModelRulesManager	getModelRulesManager() Provides the graph rules manager instance for this context.
abstract AbstractCanvasHandler	getWrapped()
protected void	loadRules(org.uberfire.mvp.Command loadCallback) Load the necessary rules into the graph and model rules manager member instances.

Methods inherited from class org.kie.workbench.common.stunner.core.client.canvas.BaseCanvasHandler

addChild, addShape, afterDraw, afterElementAdded, afterElementDeleted, afterElementUpdated, applyElementMutation, beforeDraw, beforeElementDeleted, beforeElementUpdated, deregister, dock, doClear, doDestroy, draw, draw, getCanvas, getDefinitionId, getDefinitionManager, getDiagram, getGraphUtils, getShapeFactory, getShapeManager, handle, handleParentChildZIndex, handleZIndex, handleZIndex, handleZIndex, isCanvasRoot, register, removeChild, removeShape, showError, undock

Methods inherited from class org.kie.workbench.common.stunner.core.client.canvas.AbstractCanvasHandler

addRegistrationListener, applyElementMutation, applyElementMutation, clear, clearCanvas, clearRegistrationListeners, deregister, deregister, destroy, equals, getAbstractCanvas, getUuid, hashCode, isCanvasRoot, notifyCanvasClear, notifyCanvasElementAdded, notifyCanvasElementRemoved, notifyCanvasElementUpdated, register, register, removeRegistrationListener, toString, updateElementPosition, updateElementProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CanvasHandlerProxy

public CanvasHandlerProxy(DefinitionManager definitionManager,
                          GraphUtils graphUtils,
                          ShapeManager shapeManager)

Method Detail

getWrapped

public abstract AbstractCanvasHandler getWrapped()

getGraphRulesManager

public GraphRulesManager getGraphRulesManager()

Description copied from class: AbstractCanvasHandler

Provides the graph rules manager instance for this context. If the implementation class handles rules, this manager will be populated once loading the diagram instance.

Specified by:

getGraphRulesManager in class AbstractCanvasHandler<D extends Diagram,C extends AbstractCanvas>

getModelRulesManager

public ModelRulesManager getModelRulesManager()

Description copied from class: AbstractCanvasHandler

Provides the graph rules manager instance for this context. If the implementation class handles rules, this manager will be populated once loading the diagram instance.

Specified by:

getModelRulesManager in class AbstractCanvasHandler<D extends Diagram,C extends AbstractCanvas>

getGraphIndex

public Index<?,?> getGraphIndex()

Description copied from class: AbstractCanvasHandler

Returns the graph index instance to perform lookups over the graph structure foe this canvas handler's diagram instance loaded. Implementation can provide custom graph index types, if necessary targeted and optimized for a concrete graph structure.

Specified by:

getGraphIndex in class AbstractCanvasHandler<D extends Diagram,C extends AbstractCanvas>

getGraphExecutionContext

public GraphCommandExecutionContext getGraphExecutionContext()

Description copied from class: AbstractCanvasHandler

Should return a graph execution context to perform the model updates applied by the graph command executions. If the implementation is not going to perform model updates, the graph execution context can be either null or an empty context type.

Specified by:

getGraphExecutionContext in class AbstractCanvasHandler<D extends Diagram,C extends AbstractCanvas>

buildGraphIndex

protected void buildGraphIndex(org.uberfire.mvp.Command loadCallback)

Description copied from class: BaseCanvasHandler

Build the graph index instance using any concrete index/builder types. This abstract implementation expects a not null instance for the graph index.

Specified by:

buildGraphIndex in class BaseCanvasHandler<D extends Diagram,C extends AbstractCanvas>

Parameters:

loadCallback - Callback to run once load finishes. This kind of indexes could be loaded or cached in/from server side as well.

loadRules

protected void loadRules(org.uberfire.mvp.Command loadCallback)

Description copied from class: BaseCanvasHandler

Load the necessary rules into the graph and model rules manager member instances. No rules are supported, so subtypes targeted for read-only purposes or subtyes that can ensure the commands and graph structure is always valid, can avoid adding rules into the manager instances.

Specified by:

loadRules in class BaseCanvasHandler<D extends Diagram,C extends AbstractCanvas>

Parameters:

loadCallback - Callback to run once rules have been loaded, if any.

destroyGraphIndex

protected void destroyGraphIndex(org.uberfire.mvp.Command callback)

Description copied from class: BaseCanvasHandler

Destroys this instance' graph index.

Specified by:

destroyGraphIndex in class BaseCanvasHandler<D extends Diagram,C extends AbstractCanvas>

Parameters:

callback - Callback to run once index has been destroyed.