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

Class BaseCanvasHandler<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>

Type Parameters:

D - The diagram type.

C - The handled canvas type.

All Implemented Interfaces:

CanvasHandler<D,C>, HasCanvasListeners<CanvasElementListener>

Direct Known Subclasses:

CanvasHandlerImpl, CanvasHandlerProxy

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

A base canvas handler type that provides implementations for most of the public API methods for the AbstractCanvasHandler super-type. You can use this type if: - You need a custom graph index or graph index builder types. - You need custom rule loading or do not want support for rules and their evaluations. - You need custom draw logics.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addChild(Element parent, Element child) This method sets the given child instance as children for the given given parent instance.
void	addShape(Shape shape)
protected void	afterDraw(Element element, Shape shape)
protected void	afterElementAdded(Element element, Shape shape)
protected void	afterElementDeleted(Element element, Shape shape)
protected void	afterElementUpdated(Element element, Shape shape)
protected void	applyElementMutation(Shape shape, Element candidate, boolean applyPosition, boolean applyProperties, MutationContext mutationContext)
protected void	beforeDraw(Element element, Shape shape)
protected void	beforeElementDeleted(Element element, Shape shape)
protected void	beforeElementUpdated(Element element, Shape shape)
protected abstract void	buildGraphIndex(org.uberfire.mvp.Command loadCallback) Build the graph index instance using any concrete index/builder types.
protected void	deregister(Shape shape, Element element, boolean fireEvents)
protected abstract void	destroyGraphIndex(org.uberfire.mvp.Command loadCallback) Destroys this instance' graph index.
void	dock(Element parent, Element child) This method sets the given child instance as docked child for the given given parent instance.
CanvasHandler<D,C>	doClear() Subtypes must clear this instance's state here.
void	doDestroy() Subtypes must destroy this instance's state here.
void	draw(D diagram, org.uberfire.mvp.ParameterizedCommand<CommandResult<?>> loadCallback)
protected abstract void	draw(org.uberfire.mvp.ParameterizedCommand<CommandResult<?>> loadCallback) Delegates the draw behavior to the subtypes.
C	getCanvas()
protected String	getDefinitionId(Object definition)
DefinitionManager	getDefinitionManager() Provides a definition manager instance in this context.
D	getDiagram()
GraphUtils	getGraphUtils()
protected ShapeFactory<Object,AbstractCanvasHandler,Shape>	getShapeFactory(String shapeSetId)
ShapeManager	getShapeManager()
CanvasHandler<D,C>	handle(C canvas)
protected void	handleParentChildZIndex(Element parent, Element child, Shape parentShape, Shape childShape, boolean add)
protected void	handleZIndex(Element child, int zindex)
protected void	handleZIndex(Set<String> shapeUUIDs, int zindex)
protected void	handleZIndex(Shape shape, int zindex)
protected boolean	isCanvasRoot(String pUUID)
protected abstract void	loadRules(org.uberfire.mvp.Command loadCallback) Load the necessary rules into the graph and model rules manager member instances.
protected void	register(Shape shape, Element<View<?>> candidate, boolean fireEvents)
void	removeChild(Element parent, Element child) This method removes the given child instance as children for the given given parent instance.
void	removeShape(Shape shape)
protected void	showError(ClientRuntimeError error)
void	undock(Element parent, Element child) This method removes the given child instance as docked child for the given given parent instance.

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

addRegistrationListener, applyElementMutation, applyElementMutation, clear, clearCanvas, clearRegistrationListeners, deregister, deregister, destroy, equals, getAbstractCanvas, getGraphExecutionContext, getGraphIndex, getGraphRulesManager, getModelRulesManager, 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

BaseCanvasHandler

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

Method Detail

buildGraphIndex

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

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

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 abstract void loadRules(org.uberfire.mvp.Command loadCallback)

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.

Parameters:

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

draw

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

Delegates the draw behavior to the subtypes.

Parameters:

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

destroyGraphIndex

protected abstract void destroyGraphIndex(org.uberfire.mvp.Command loadCallback)

Destroys this instance' graph index.

Parameters:

loadCallback - Callback to run once index has been destroyed.

handle

public CanvasHandler<D,C> handle(C canvas)

draw

public void draw(D diagram,
                 org.uberfire.mvp.ParameterizedCommand<CommandResult<?>> loadCallback)

getCanvas

public C getCanvas()

getDiagram

public D getDiagram()

getShapeFactory

protected ShapeFactory<Object,AbstractCanvasHandler,Shape> getShapeFactory(String shapeSetId)

Specified by:

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

register

protected void register(Shape shape,
                        Element<View<?>> candidate,
                        boolean fireEvents)

Specified by:

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

deregister

protected void deregister(Shape shape,
                          Element element,
                          boolean fireEvents)

Specified by:

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

addShape

public void addShape(Shape shape)

removeShape

public void removeShape(Shape shape)

applyElementMutation

protected void applyElementMutation(Shape shape,
                                    Element candidate,
                                    boolean applyPosition,
                                    boolean applyProperties,
                                    MutationContext mutationContext)

Specified by:

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

beforeDraw

protected void beforeDraw(Element element,
                          Shape shape)

afterDraw

protected void afterDraw(Element element,
                         Shape shape)

addChild

public void addChild(Element parent,
                     Element child)

Description copied from class: AbstractCanvasHandler

This method sets the given child instance as children for the given given parent instance. It sets the shape for the child instance as child shape for the parent instance's shape.

Specified by:

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

Parameters:

parent - The parent graph element.

child - The graph element to set as child.

removeChild

public void removeChild(Element parent,
                        Element child)

Description copied from class: AbstractCanvasHandler

This method removes the given child instance as children for the given given parent instance. It removes the shape for the child instance as child shape for the parent instance's shape.

Specified by:

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

Parameters:

parent - The parent graph element.

child - The element to remove as a child from the parent.

isCanvasRoot

protected boolean isCanvasRoot(String pUUID)

dock

public void dock(Element parent,
                 Element child)

Description copied from class: AbstractCanvasHandler

This method sets the given child instance as docked child for the given given parent instance. It sets the shape for the child instance as a docked child shape for the parent instance's shape.

Specified by:

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

Parameters:

parent - The parent graph element.

child - The graph element to set as a docked child.

undock

public void undock(Element parent,
                   Element child)

Description copied from class: AbstractCanvasHandler

This method removes the given child instance as docked child for the given given parent instance. It removes the shape for the child instance as a docked child shape for the parent instance's shape.

Specified by:

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

Parameters:

parent - The parent graph element.

child - The element to remove as a docked child from the parent.

afterElementAdded

protected void afterElementAdded(Element element,
                                 Shape shape)

beforeElementDeleted

protected void beforeElementDeleted(Element element,
                                    Shape shape)

afterElementDeleted

protected void afterElementDeleted(Element element,
                                   Shape shape)

beforeElementUpdated

protected void beforeElementUpdated(Element element,
                                    Shape shape)

afterElementUpdated

protected void afterElementUpdated(Element element,
                                   Shape shape)

handleParentChildZIndex

protected void handleParentChildZIndex(Element parent,
                                       Element child,
                                       Shape parentShape,
                                       Shape childShape,
                                       boolean add)

handleZIndex

protected void handleZIndex(Element child,
                            int zindex)

handleZIndex

protected void handleZIndex(Set<String> shapeUUIDs,
                            int zindex)

handleZIndex

protected void handleZIndex(Shape shape,
                            int zindex)

doClear

public CanvasHandler<D,C> doClear()

Description copied from class: AbstractCanvasHandler

Subtypes must clear this instance's state here.

Specified by:

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

doDestroy

public void doDestroy()

Description copied from class: AbstractCanvasHandler

Subtypes must destroy this instance's state here.

Specified by:

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

showError

protected void showError(ClientRuntimeError error)

getDefinitionManager

public DefinitionManager getDefinitionManager()

Description copied from class: AbstractCanvasHandler

Provides a definition manager instance in this context.

Specified by:

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

getGraphUtils

public GraphUtils getGraphUtils()

getShapeManager

public ShapeManager getShapeManager()

getDefinitionId

protected String getDefinitionId(Object definition)