IBM ILOG Dojo Diagrammer 1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.diagram.adorners.Adorner

Object » graphCreator » dojox.gfx.Group » ibm_ilog.diagram.adorners.TemplatedOverlay » ibm_ilog.diagram.adorners.Adorner

The Adorner object provides a graphical decoration for a graph entity. The decoration is composed of a graphical representation given by the adorner template and also by a set of smaller AdornerHandle entities. Each adorner usually defines a fixed set of handles which can be used. AdornerHandles usually provide an interactive service to the user. For example, the handle can connect to the onmousedown event of its shapes to perform some kind of action on the adorned. If this action leads to an interaction process that is not instantaneous, then the AdornerHandle can push an Interactor object into the interactors stack, blocking other conflicting interactors temporarily while the action is performed. For example, during the creation of links some interactions may be disabled. construction: Adorners don't use parameterized constructors. Instead, they rely on an initialize method. For example: new ibm_ilog.diagram.editor.ResizeAdorner().initialize(diagram, templatePool, "ResizeAdorner0"); The reason for this is that the creation is implemented with a template method, and thus the template code implemented in the superclass needs the methods already overriden. Currently dojo executes superclass constructors before overriding methods redeclared in the subclass. TODO: . update extendCreateShape for using deserialization . change individual props for composite: elemBounds instead of elemLeft, elemTop, elemW, elemH

Method Summary

Event Summary

Attached Objects

Methods

activate
activates the adorner
deactivate
deactivates the adorner
destroy
removes the diagram connection
forceUpdate
Used to clear the timeout and update the adorner shape immediately.
getAdorned
gets the bounded element
getBaseShape
getBounds
A rectangle (i.e. an object with x/y/width/height properties) containing the bounds of the node in the specified coordinate space.
Returns the bounds of this node in the coordinate space of the specified parent.
ParameterTypeDescription
parentdojox.gfx.GroupThe parent object that determines the coordinate space the bounds are relative to. If null or undefined, the bounds of the node relative to its parent are returned.
getDiagram
gets the diagram
getId
Defined by dojox.gfx.Group, ibm_ilog.diagram.adorners.TemplatedOverlay
getViewport
gets the viewport
gfxConnector
ParameterTypeDescription
src
evt
object
handler
gfxDisconnector
ParameterTypeDescription
handle
src
initialize
Initializes an Adorner after construction.
ParameterTypeDescription
diagramTheDiagram Dijit
templatePoolThetemplate pool. The adorner gets its template from this pool using the templateId argument, and also for instantiating its handles with the templates from the pool.
templateIdtheId for the adorner template in the pool
setAdorned
apply the adorner to the given element
ParameterTypeDescription
element

Events

onChanged