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.AnnotationAdorner (version 1.1-SNAPSHOT)

Object » graphCreator » dojox.gfx.Group » ibm_ilog.diagram.adorners.TemplatedOverlay » ibm_ilog.diagram.adorners.Adorner » ibm_ilog.diagram.adorners.AnnotationAdorner
dojo.require("ibm_ilog.diagram.adorners.AnnotationAdorner");

An Adorner which displays node annotations

Property Summary

  • annotationChangedEvent event to watch for associated with the annotation changing its value.
  • annotationGetter method to invoke in the adorned entity to get the annotation. This is used in the default implementation of refreshAnnotation.

Method Summary

Event Summary

Properties

annotationChangedEvent
event to watch for associated with the annotation changing its value.
annotationGetter
method to invoke in the adorned entity to get the annotation. This is used in the default implementation of refreshAnnotation.

Methods

constructor
Defined by dojox.gfx.Group
forceUpdate
Used to clear the timeout and update the adorner shape immediately.
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.
getId
Defined by dojox.gfx.Group
getLink
getTarget
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
refreshAnnotation

Current implementation relies on the template referencing the "annotation" bindable property of the receiver. Can be overriden by subclasses to produce specific ways of rendering the annotation like word wrap, etc.

setAdorned
apply the adorner to the given element
ParameterTypeDescription
adorned
setLink
ParameterTypeDescription
link
target

Events