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

Class CanvasHandlerImpl<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.CanvasHandlerImpl<D,C>

Type Parameters:

D - The diagram type.

C - The handled canvas type.

All Implemented Interfaces:

CanvasHandler<D,C>, HasCanvasListeners<CanvasElementListener>

@Dependent
public class CanvasHandlerImpl<D extends Diagram,C extends AbstractCanvas>
extends BaseCanvasHandler<D,C>

The default canvas handler type implementation for any sutype of AbstractCanvas view and any subtype of Diagram model.

Constructor Summary

Constructors

Constructor and Description

CanvasHandlerImpl(ClientDefinitionManager clientDefinitionManager, CanvasCommandFactory commandFactory, ClientFactoryService clientFactoryServices, GraphRulesManager graphRulesManager, ModelRulesManager modelRulesManager, GraphUtils graphUtils, GraphIndexBuilder<? extends MutableIndex<Node,Edge>> indexBuilder, ShapeManager shapeManager, javax.enterprise.event.Event<CanvasElementAddedEvent> canvasElementAddedEvent, javax.enterprise.event.Event<CanvasElementRemovedEvent> canvasElementRemovedEvent, javax.enterprise.event.Event<CanvasElementUpdatedEvent> canvasElementUpdatedEvent, javax.enterprise.event.Event<CanvasElementsClearEvent> canvasElementsClearEvent)

Method Summary

Modifier and Type	Method and Description
protected void	afterElementAdded(Element element, Shape shape)
protected void	afterElementDeleted(Element element, Shape shape)
protected void	afterElementUpdated(Element element, Shape shape)
protected void	beforeElementDeleted(Element element, Shape shape)
protected void	beforeElementUpdated(Element element, Shape shape)
protected void	buildGraphIndex(org.uberfire.mvp.Command loadCallback) Build the graph index instance using any concrete index/builder types.
void	clearCanvas()
protected void	destroyGraphIndex(org.uberfire.mvp.Command callback) Destroys this instance' graph index.
protected void	draw(org.uberfire.mvp.ParameterizedCommand<CommandResult<?>> loadCallback) Delegates the draw behavior to the subtypes.
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.
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, applyElementMutation, beforeDraw, deregister, dock, doClear, doDestroy, 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, 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

CanvasHandlerImpl

@Inject
public CanvasHandlerImpl(ClientDefinitionManager clientDefinitionManager,
                                 CanvasCommandFactory commandFactory,
                                 ClientFactoryService clientFactoryServices,
                                 GraphRulesManager graphRulesManager,
                                 ModelRulesManager modelRulesManager,
                                 GraphUtils graphUtils,
                                 GraphIndexBuilder<? extends MutableIndex<Node,Edge>> indexBuilder,
                                 ShapeManager shapeManager,
                                 javax.enterprise.event.Event<CanvasElementAddedEvent> canvasElementAddedEvent,
                                 javax.enterprise.event.Event<CanvasElementRemovedEvent> canvasElementRemovedEvent,
                                 javax.enterprise.event.Event<CanvasElementUpdatedEvent> canvasElementUpdatedEvent,
                                 javax.enterprise.event.Event<CanvasElementsClearEvent> canvasElementsClearEvent)

Method Detail

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.

draw

protected void draw(org.uberfire.mvp.ParameterizedCommand<CommandResult<?>> loadCallback)

Description copied from class: BaseCanvasHandler

Delegates the draw behavior to the subtypes.

Specified by:

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

Parameters:

loadCallback - Callback to run once draw has finished. It must provide a result for the draw operation/s.

clearCanvas

public void clearCanvas()

Overrides:

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

afterElementAdded

protected void afterElementAdded(Element element,
                                 Shape shape)

Overrides:

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

beforeElementDeleted

protected void beforeElementDeleted(Element element,
                                    Shape shape)

Overrides:

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

afterElementDeleted

protected void afterElementDeleted(Element element,
                                   Shape shape)

Overrides:

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

beforeElementUpdated

protected void beforeElementUpdated(Element element,
                                    Shape shape)

Overrides:

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

afterElementUpdated

protected void afterElementUpdated(Element element,
                                   Shape shape)

Overrides:

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

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.