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

Object » ibm_ilog.diagram.Selection
dojo.require("ibm_ilog.diagram.Selection");

creates a new instance

Property Summary

Method Summary

  • accept(element)
  • add(elements, forceClear) sets the desired as selected, and add it to the selected list (if not in the list yet). Also connect the element to react to the selectableChanged method
  • clear() sets the selection state of all the elements in the selected list as false, and clear the list. If any element is removed from the selection, a notification is thrown.
  • constructor(diagram, options) creates a new instance
  • fastGet() gets the ArrayList of selected elements
  • get() gets the ArrayList of selected elements
  • getLinkSelectionEnabled() gets if link Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
  • getMultiSelectionEnabled() gets if multi-Selection is enabled (true by default)
  • getNodeSelectionEnabled() gets if Node Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
  • instantiateSelectionStrategy(diagram, options)
  • remove(elements, isDisposed) sets the desired as unselected, and remove it from the selected list (if in the list).
  • selectAll(graph, options) select all elements in a graph
  • setLinkSelectionEnabled(enabled) sets if link Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
  • setMultiSelectionEnabled(enabled) sets if multi-Selection is enabled (true by default)
  • setNodeSelectionEnabled(enabled) sets if node Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.

Event Summary

Properties

dataStore_multi
dataStore_single
gfx_multi
gfx_single
standard

Methods

accept
ParameterTypeDescription
element
add
sets the desired as selected, and add it to the selected list (if not in the list yet). Also connect the element to react to the selectableChanged method
ParameterTypeDescription
elementsasingle element or an array of elements
forceClear
clear
sets the selection state of all the elements in the selected list as false, and clear the list. If any element is removed from the selection, a notification is thrown.
constructor
creates a new instance
ParameterTypeDescription
diagram
options
fastGet
gets the ArrayList of selected elements
get
gets the ArrayList of selected elements
getLinkSelectionEnabled
gets if link Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
getMultiSelectionEnabled
gets if multi-Selection is enabled (true by default)
getNodeSelectionEnabled
gets if Node Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
instantiateSelectionStrategy
ParameterTypeDescription
diagram
options
remove
sets the desired as unselected, and remove it from the selected list (if in the list).
ParameterTypeDescription
elementsasingle element or an array of elements
isDisposed
selectAll
select all elements in a graph
ParameterTypeDescription
graphthegraph containing all the items to be selected
optionsoptions.noCheck:if true, skip checking each item is accepted by the receiver
setLinkSelectionEnabled
sets if link Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
ParameterTypeDescription
enabled
setMultiSelectionEnabled
sets if multi-Selection is enabled (true by default)
ParameterTypeDescription
enabled
setNodeSelectionEnabled
sets if node Selection is enabled (true by default) this enablement only affects the accept(graphelement) return value.
ParameterTypeDescription
enabled

Events

onElementDisposed
ParameterTypeDescription
graphElement
onSelectionChanged
ParameterTypeDescription
added
removed