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.editor.adorners.TextEditAdorner

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

TextEditAdorner is an adorner that displays a TextBox for editing a property of a Graph element. The user must provide an attachPoint name for the property which is used to calculate the position of the TextBox, and also a getter and setter of the property at the Graph element. usage: The following code starts editing the "label" attribute of "node", using getLabel/setLabel as accessorsm and "textShape" as value representation for reference when positioning the TextBox textEditAdorner.setAccessors( function(adorned){ return adorned.getLabel(); }, function(adorned,value){ adorned.setLabel(value); }); textEditAdorner.setComponent("textShape"); textEditAdorner.setAdorned(node);

Method Summary

  • activate() activates the adorner
  • clear() Clear the value of the TextBox
  • constructor()
  • 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(parent) Returns the bounds of this node in the coordinate space of the specified parent.
  • getComponent() Returns the attachPoint name of the visual shape associated with the property.
  • getComponentAttachPoint() Returns the attachPoint name of the visual shape associated with the property.
  • getDiagram() gets the diagram
  • getId()
  • getViewport() gets the viewport
  • initialize(diagram, templatePool, templateId) Initializes an Adorner after construction.
  • reset() Rest the value of the TextBox to the original value found at the adorned object
  • setAccessors(getter, setter) Configure the receiver with the setter and getter functions for the property on the graph element.
  • setAdorned(e) Change the adorned object. This causes the TextBox to appear at the corresponding location (based on the location of the graph element and the location of the property shown inside the element). If null, the TextBox is hidden and unbinded.
  • setComponent(component) Sets the attachPoint name of visual shape associated with the property. If null the whole element shape is asummed.
  • setComponentAttachPoint(a) Sets the component original attachpoint
  • setOptions(options)

Event Summary

Methods

activate
activates the adorner
clear
Clear the value of the TextBox
constructor
Defined by dojox.gfx.Group
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
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.
getComponent
Returns the attachPoint name of the visual shape associated with the property.
getComponentAttachPoint
Returns the attachPoint name of the visual shape associated with the property.
getDiagram
gets the diagram
getId
Defined by dojox.gfx.Group
getViewport
gets the viewport
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
reset
Rest the value of the TextBox to the original value found at the adorned object
setAccessors
Configure the receiver with the setter and getter functions for the property on the graph element.
ParameterTypeDescription
getter
setter
setAdorned
Change the adorned object. This causes the TextBox to appear at the corresponding location (based on the location of the graph element and the location of the property shown inside the element). If null, the TextBox is hidden and unbinded.
ParameterTypeDescription
e
setComponent
Sets the attachPoint name of visual shape associated with the property. If null the whole element shape is asummed.
ParameterTypeDescription
componentShape|string|null
setComponentAttachPoint
Sets the component original attachpoint
ParameterTypeDescription
a
setOptions
ParameterTypeDescription
options

Events