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.GraphElement

Object » graphCreator » dojox.gfx.Group » ibm_ilog.diagram.GraphElement
dojo.require("ibm_ilog.diagram.GraphElement");

An element that can be contained in a Graph.

dojox.gfx.Group, ibm_ilog.diagram.Selectable, ibm_ilog.diagram.templating._DiagramTemplated

Method Summary

Event Summary

  • onPropertyChanged(property, oldValue, newValue) Called when a bindable property has changed.
  • onTemplateApplied(template) Invoked when the template has been applied.
  • onTemplateError(template, e) Invoked if an error is raised when applying the specified template .

Methods

addConnection
this method should be called on every dojo.connect done to the graph element that should be disconnected on dispose.
ParameterTypeDescription
connection
afterDisposing

This function free all possible listeners

ParameterTypeDescription
graphElement
applyTemplate
Defined by ibm_ilog.diagram.templating._DiagramTemplated
Applies the specified template on this instance.
ParameterTypeDescription
templateObjector string : the template to apply.
contextObject: the runtime context. Optional. If not specified, the runtime context is this shape instance.
beforeDisposing
This function is called before disposing the GraphElement
ParameterTypeDescription
graphElement
byShape
Returns the GraphElement that contains the specified shape, or null.
ParameterTypeDescription
shape
connect
override gfx.connect to add the handle to the internal list
constructor
disconnectAll
This function is disconnect every dojo.connect attached to this element
dispose

This function should be called when the GraphElement is completely deleted, that is, when it is removed from its parent graph and it will never be used again.

ParameterTypeDescription
optionsoptions.noRecurse:Do not recurse children
endDTLBatch
Defined by ibm_ilog.diagram.templating._DiagramTemplated
getId
isSelectable
return if the selectable can be selected
isSelected
true if selected
returns the selected state
layoutShape
Defined by ibm_ilog.diagram.templating._DiagramTemplated
ParameterTypeDescription
target{shape}
setSelectable
enable or disable selecting enabled: true to enable selecting
ParameterTypeDescription
selectable
setSelected
true if the selection state could be changed
sets the selected state
ParameterTypeDescription
selectedthenew selection state
shallowInstantiateAt
Defined by ibm_ilog.diagram.templating._DiagramTemplated
ParameterTypeDescription
target
template
startDTLBatch
Defined by ibm_ilog.diagram.templating._DiagramTemplated
toString
toggleSelected
true if the selection state could be changed
toggle the selection state

Events

onPropertyChanged
Defined by ibm_ilog.diagram.templating._DiagramTemplated

Bindable properties are properties defined on a Node or a Link and that can be used in templates using bindings.

ParameterTypeDescription
property
oldValue
newValue
onTemplateApplied
Defined by ibm_ilog.diagram.templating._DiagramTemplated
Invoked when the template has been applied.
ParameterTypeDescription
templateObjector string : the template to apply.
onTemplateError
Defined by ibm_ilog.diagram.templating._DiagramTemplated
Invoked if an error is raised when applying the specified template .
ParameterTypeDescription
templateObjector string : the template to apply.
eException