AbstractCanvasHandler (Kie Workbench - Common - Stunner

java.lang.Object
- org.kie.workbench.common.stunner.core.client.canvas.AbstractCanvasHandler<D,C>

Type Parameters:

D - The diagram type.

C - The handled canvas type.

All Implemented Interfaces:

CanvasHandler<D,C>, HasCanvasListeners<CanvasElementListener>

Direct Known Subclasses:

BaseCanvasHandler
```
public abstract class AbstractCanvasHandler<D extends Diagram,C extends AbstractCanvas>
extends Object
implements CanvasHandler<D,C>, HasCanvasListeners<CanvasElementListener>
```
This type is the canvas handler type used as default by Stunner, most of the component implementations rely on this public API handler type. If you need to provide a custom canvas handler for you Definition Set, is a good idea to create the handler as a subtype for AbstractCanvasHandler, so most of the different IOC resolutions that Stunner requires on other areas will be, at least, resolved with the default implementations that rely on subtypes for AbstractCanvasHandler.

Constructor Summary

Constructors
Constructor and Description

AbstractCanvasHandler()

Constructors
Constructor and Description
`AbstractCanvasHandler()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addChild(Element parent, Element child)` This method sets the given `child` instance as children for the given given `parent` instance.
`HasCanvasListeners<CanvasElementListener>`	`addRegistrationListener(CanvasElementListener instance)` Adds a listener instance in order to be notified about graph element structure updates.
`protected void`	`applyElementMutation(Element candidate, boolean applyPosition, boolean applyProperties, MutationContext mutationContext)`
`void`	`applyElementMutation(Element element, MutationContext mutationContext)` When an element has been changed, this method produces to update the handler and the canvas and mutates the shape bind to the given element using new properties and/or values.
`protected abstract void`	`applyElementMutation(Shape shape, Element candidate, boolean applyPosition, boolean applyProperties, MutationContext mutationContext)`
`CanvasHandler<D,C>`	`clear()` Clears this handler state and the handled canvas instance.
`void`	`clearCanvas()`
`HasCanvasListeners<CanvasElementListener>`	`clearRegistrationListeners()` Clears all the registered listeners.
`void`	`deregister(Element element)` Deregisters an element from the graph structure and from the canvas.
`void`	`deregister(Element element, boolean fireEvents)` De-registers an element from the graph structure and from the canvas.
`protected abstract void`	`deregister(Shape shape, Element element, boolean fireEvents)`
`void`	`destroy()` Destroys this handler state and the handled canvas instance.
`abstract void`	`dock(Element parent, Element child)` This method sets the given `child` instance as docked child for the given given `parent` instance.
`protected abstract CanvasHandler<D,C>`	`doClear()` Subtypes must clear this instance's state here.
`protected abstract void`	`doDestroy()` Subtypes must destroy this instance's state here.
`boolean`	`equals(Object o)`
`AbstractCanvas`	`getAbstractCanvas()` Used to avoid forcing specifying the generic for the canvas type from other beans.
`abstract DefinitionManager`	`getDefinitionManager()` Provides a definition manager instance in this context.
`abstract GraphCommandExecutionContext`	`getGraphExecutionContext()` Should return a graph execution context to perform the model updates applied by the graph command executions.
`abstract Index<?,?>`	`getGraphIndex()` Returns the graph index instance to perform lookups over the graph structure foe this canvas handler's diagram instance loaded.
`abstract GraphRulesManager`	`getGraphRulesManager()` Provides the graph rules manager instance for this context.
`abstract ModelRulesManager`	`getModelRulesManager()` Provides the graph rules manager instance for this context.
`protected abstract ShapeFactory<Object,AbstractCanvasHandler,Shape>`	`getShapeFactory(String shapeSetId)`
`protected String`	`getUuid()`
`int`	`hashCode()`
`protected boolean`	`isCanvasRoot(Element parent)`
`protected void`	`notifyCanvasClear()` Notifies a clean canvas to the listeners.
`void`	`notifyCanvasElementAdded(Element candidate)` Notifies an element added to the listeners.
`void`	`notifyCanvasElementRemoved(Element candidate)` Notifies an element removed to the listeners.
`void`	`notifyCanvasElementUpdated(Element candidate)` Notifies an element updated to the listeners.
`protected abstract void`	`register(Shape shape, Element<View<?>> candidate, boolean fireEvents)`
`void`	`register(ShapeFactory<Object,AbstractCanvasHandler,Shape> factory, Element<View<?>> candidate, boolean fireEvents)` It does: - Registers a new graph element into the structure - Creates the shape for the element to register, using the given shape factory.
`void`	`register(String shapeSetId, Element<View<?>> candidate)` It does: - Registers a new graph element into the structure - Creates the shape for the element to register, using the shape factory provided for the given `shapeSetId` value.
`abstract void`	`removeChild(Element parent, Element child)` This method removes the given `child` instance as children for the given given `parent` instance.
`HasCanvasListeners<CanvasElementListener>`	`removeRegistrationListener(CanvasElementListener instance)` Removes a previously register listener instance.
`String`	`toString()`
`abstract void`	`undock(Element parent, Element child)` This method removes the given `child` instance as docked child for the given given `parent` instance.
`void`	`updateElementPosition(Element element, MutationContext mutationContext)` When an element has been changed, this method produces to update the coordinates for the shape bind to the given element.
`void`	`updateElementProperties(Element element, MutationContext mutationContext)` When an element has been changed, this method produces to update the handler and the canvas and mutates the shape bind to the given element using new properties and/or values.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kie.workbench.common.stunner.core.client.canvas.CanvasHandler
draw, getCanvas, getDiagram, handle

- Constructor Detail
  - AbstractCanvasHandler
```
public AbstractCanvasHandler()
```
- Method Detail
  - getDefinitionManager
```
public abstract DefinitionManager getDefinitionManager()
```
    Provides a definition manager instance in this context.
  - getGraphRulesManager
```
public abstract GraphRulesManager getGraphRulesManager()
```
    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.
  - getModelRulesManager
```
public abstract ModelRulesManager getModelRulesManager()
```
    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.
  - getGraphIndex
```
public abstract Index<?,?> getGraphIndex()
```
    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.
  - getGraphExecutionContext
```
public abstract GraphCommandExecutionContext getGraphExecutionContext()
```
    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.
  - addChild
```
public abstract void addChild(Element parent,
                              Element child)
```
    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.
    
    Parameters:
    
    parent - The parent graph element.
    
    child - The graph element to set as child.
  - removeChild
```
public abstract void removeChild(Element parent,
                                 Element child)
```
    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.
    
    Parameters:
    
    parent - The parent graph element.
    
    child - The element to remove as a child from the parent.
  - dock
```
public abstract void dock(Element parent,
                          Element child)
```
    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.
    
    Parameters:
    
    parent - The parent graph element.
    
    child - The graph element to set as a docked child.
  - undock
```
public abstract void undock(Element parent,
                            Element child)
```
    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.
    
    Parameters:
    
    parent - The parent graph element.
    
    child - The element to remove as a docked child from the parent.
  - doClear
```
protected abstract CanvasHandler<D,C> doClear()
```
    Subtypes must clear this instance's state here.
  - doDestroy
```
protected abstract void doDestroy()
```
    Subtypes must destroy this instance's state here.
  - register
```
protected abstract void register(Shape shape,
                                 Element<View<?>> candidate,
                                 boolean fireEvents)
```
  - deregister
```
protected abstract void deregister(Shape shape,
                                   Element element,
                                   boolean fireEvents)
```
  - applyElementMutation
```
protected abstract void applyElementMutation(Shape shape,
                                             Element candidate,
                                             boolean applyPosition,
                                             boolean applyProperties,
                                             MutationContext mutationContext)
```
  - getShapeFactory
```
protected abstract ShapeFactory<Object,AbstractCanvasHandler,Shape> getShapeFactory(String shapeSetId)
```
  - register
```
public void register(String shapeSetId,
                     Element<View<?>> candidate)
```
    It does: - Registers a new graph element into the structure - Creates the shape for the element to register, using the shape factory provided for the given shapeSetId value.
    
    Parameters:
    
    shapeSetId - The identifier for the ShapeSet to use.
    
    candidate - The graph element to register.
  - register
```
public void register(ShapeFactory<Object,AbstractCanvasHandler,Shape> factory,
                     Element<View<?>> candidate,
                     boolean fireEvents)
```
    It does: - Registers a new graph element into the structure - Creates the shape for the element to register, using the given shape factory.
    
    Parameters:
    
    factory - The shape factory to use.
    
    candidate - The graph element to register.
    
    fireEvents - If canvas and canvas handled registration events must be fired.
  - deregister
```
public void deregister(Element element)
```
    Deregisters an element from the graph structure and from the canvas.
    
    Parameters:
    
    element - The element to deregister and remove from the canvas.
  - deregister
```
public void deregister(Element element,
                       boolean fireEvents)
```
    De-registers an element from the graph structure and from the canvas.
    
    Parameters:
    
    element - The element to de-register and remove from the canvas.
    
    fireEvents - If canvas and canvas handled registration events must be fired.
  - applyElementMutation
```
public void applyElementMutation(Element element,
                                 MutationContext mutationContext)
```
    When an element has been changed, this method produces to update the handler and the canvas and mutates the shape bind to the given element using new properties and/or values. This method checks all available element properties and can potentially change the shape coordinates, size,or whatever property that produces any visual effect on the canvas.
    
    Parameters:
    
    element - The element that has been updated.
    
    mutationContext - The context for the shape mutations.
  - updateElementPosition
```
public void updateElementPosition(Element element,
                                  MutationContext mutationContext)
```
    When an element has been changed, this method produces to update the coordinates for the shape bind to the given element.
    
    Parameters:
    
    element - The element that has been updated.
    
    mutationContext - The context for the shape mutations.
  - updateElementProperties
```
public void updateElementProperties(Element element,
                                    MutationContext mutationContext)
```
    When an element has been changed, this method produces to update the handler and the canvas and mutates the shape bind to the given element using new properties and/or values. This method checks all available element properties and can potentially change whatever property that produces any visual effect on the canvas, but no produces coordinates or bounds size updates.
    
    Parameters:
    
    element - The element that has been updated.
    
    mutationContext - The context for the shape mutations.
  - applyElementMutation
```
protected void applyElementMutation(Element candidate,
                                    boolean applyPosition,
                                    boolean applyProperties,
                                    MutationContext mutationContext)
```
  - addRegistrationListener
```
public HasCanvasListeners<CanvasElementListener> addRegistrationListener(CanvasElementListener instance)
```
    Adds a listener instance in order to be notified about graph element structure updates.
    
    Specified by:
    
    addRegistrationListener in interface HasCanvasListeners<CanvasElementListener>
    
    Parameters:
    
    instance - The listener instance.
  - removeRegistrationListener
```
public HasCanvasListeners<CanvasElementListener> removeRegistrationListener(CanvasElementListener instance)
```
    Removes a previously register listener instance.
    
    Specified by:
    
    removeRegistrationListener in interface HasCanvasListeners<CanvasElementListener>
    
    Parameters:
    
    instance - The listener instance.
  - clearRegistrationListeners
```
public HasCanvasListeners<CanvasElementListener> clearRegistrationListeners()
```
    Clears all the registered listeners.
    
    Specified by:
    
    clearRegistrationListeners in interface HasCanvasListeners<CanvasElementListener>
  - notifyCanvasElementRemoved
```
public void notifyCanvasElementRemoved(Element candidate)
```
    Notifies an element removed to the listeners.
  - notifyCanvasElementAdded
```
public void notifyCanvasElementAdded(Element candidate)
```
    Notifies an element added to the listeners.
  - notifyCanvasElementUpdated
```
public void notifyCanvasElementUpdated(Element candidate)
```
    Notifies an element updated to the listeners.
  - notifyCanvasClear
```
protected void notifyCanvasClear()
```
    Notifies a clean canvas to the listeners.
  - clearCanvas
```
public void clearCanvas()
```
  - clear
```
public CanvasHandler<D,C> clear()
```
    Clears this handler state and the handled canvas instance. Other further diagrams can be loaded and displayed using this handler.
    
    Specified by:
    
    clear in interface CanvasHandler<D extends Diagram,C extends AbstractCanvas>
  - destroy
```
public void destroy()
```
    Destroys this handler state and the handled canvas instance. This instance cannot be longer used and should be eligible by the garbage collector.
    
    Specified by:
    
    destroy in interface CanvasHandler<D extends Diagram,C extends AbstractCanvas>
  - getAbstractCanvas
```
public AbstractCanvas getAbstractCanvas()
```
    Used to avoid forcing specifying the generic for the canvas type from other beans.
  - isCanvasRoot
```
protected boolean isCanvasRoot(Element parent)
```
  - getUuid
```
protected String getUuid()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractCanvasHandler<D extends Diagram,C extends AbstractCanvas>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.kie.workbench.common.stunner.core.client.canvas.CanvasHandler

Constructor Detail

AbstractCanvasHandler

Method Detail

getDefinitionManager

getGraphRulesManager

getModelRulesManager

getGraphIndex

getGraphExecutionContext

addChild

removeChild

dock

undock

doClear

doDestroy

register

deregister

applyElementMutation

getShapeFactory

register

register

deregister

deregister

applyElementMutation

updateElementPosition

updateElementProperties

applyElementMutation

addRegistrationListener

removeRegistrationListener

clearRegistrationListeners

notifyCanvasElementRemoved

notifyCanvasElementAdded

notifyCanvasElementUpdated

notifyCanvasClear

clearCanvas

clear

destroy

getAbstractCanvas

isCanvasRoot

getUuid

equals

hashCode

toString