The ActionManager used by this DiagramView to manage registered actions (enable, disable, remove...).

Current active tool ID property used by this DiagramView instance.

Define if column creation is synchronous or asynchronous. If false, columns are created when a user click on the column creation button. If true, a COLUMN_CREATIONREQUEST event is dispatch. column creation must be implemented in the application.

The default value is false.

Define if lane creation is synchronous or asynchronous. If false, lanes are created when a user click on the lane creation button. If true, a LANE_CREATIONREQUEST event is dispatch. Lane creation must be implemented in the application.

The default value is false.

Define if panel creation is synchronous or asynchronous. If false, panels are created when a user click on the lane creation button. If true, a PANEL_CREATIONREQUEST event is dispatch. Panel creation must be implemented in the application.

The default value is false.

ScaleX of childrens. Used to set zoom level

ScaleY of childrens. Used to set zoom level

The DiagramColumnContainer in which all the DiagramView's panels are embedded.

Data object id of the diagram. The dataobjectid is a way to store external key to link diagram objects to application data objects. On the other side the did is an internal key use by DiagramView to managed its own serialization mechanism using XML. dataobjectid is also serialized during toXML(), which gives a way to restore relation between diagram objects and application data objects. That's why dataobjectid must be a permanent key in the application data objects or database. DiagramObject or DiagramLayer dataobjectid creation can be managed using DataModel that defines which IObjectProxy,ISpriteProxy,ILinkProxy should be used for data bindings. DiagramView databojectid should be managed directly by the developper, as it should be set only once when the diagram is first created. A diagram object linked to a given dataobjectid can be found using getElementByDataObjectId() function.

See also

Define default link creation mode. The value is used by returnToDefaultMode to set linkMode. If set to LIB_LINK_MODE, links can be created from defined zone in SVG library. If set to NO_LINK_MODE, links can not be created from defined zone in SVG library. In that case, link creation can be activated setting linkMode to MANUAL_LINK_MODE.

The default value is LIB_LINK_MODE.

See also

Default DiagramLink parameters used by UI actions

The Diagram Unique ID of this DiagramView. Every diagram element has an unique identifier which which is used for serialization. A did can be used to retreive the associated element using getElementById() function.

See also

SVG Doc Height of this DiagramView in an SVG representation (after being exported to SVG format).

The default value is DEFAULT_DOCHEIGHT.

See also

SVG Doc Width of this DiagramView in an SVG representation (after being exported to SVG format).

The default value is DEFAULT_DOCWIDTH.

See also

Enable dragging of diagram objects.

The default value is false.

Enable dropping of new diagram objects

The default value is false.

Hand mode switch. If true, a hand tool is activated and enable diagram scrolling.

The default value is false.

See also

Indicator if the control buttons hidden.

Indicates whether keyboard support is currently enabled in this DiagramView instance.

The default value is false.

Define link creation mode. If set to LIB_LINK_MODE, links can be created from defined zone in SVG library. If set to MANUAL_LINK_MODE, links are created with a link tool by click on shapes. If set to NO_LINK_MODE, no links can be created.

The default value is LIB_LINK_MODE.

See also

Define DiagramModel for this Diagram. It defines proxies to link diagram object to application data objects. It must be set only once, and before any operation in the diagram (usually in creationComplete event).

Indicates if diagram has been modified. If modified become true, a DIAGRAM_MODIFIED event is dispatched.

See also

Indicates whether multicolumn option is enabled.

The default value is true.

Indicates whether multipanel option is enabled.

The default value is true.

Indicates whether multiple selection is used in this DiagramView.

The default value is false.

The DiagramPanelsContainer in which all the DiagramView's panels are embedded.

If true, state of selection is saved when toXML() is called

The default value is true.

See also

Indicates whether selection is currently enabled in this DiagramView instance.

The default value is false.

If true, contextual menu is displayed on sprite on mouse rollover, if no tool is active (default mode).

The default value is false.

Transform mode switch. If true, a transform tool is activated and enable sprite shape modification.

The default value is false.

See also

The TweenEngine used for animation during diagram transitions.

The TextFormat used by the DiagramColumn components in this DiagramView.

The TextFormat used by the DiagramLane components in this DiagramView.

The UIs Layer embedded in this DiagramView.

The TextFormat used by the DiagramPanel components in this DiagramView.

The TextFormat used by the DiagramLane components in this DiagramView.

DiagramView version.

The diagram view of this element. The view is the DiagramView itself.

Creates a DiagramView instance by assigning its Diagram Unique ID, default size, registered actions and event listeners.

Activates or deactivates this DiagramView. An activated DiagramView interacts with mouse events and a deactivated one doesn't.

Align an array of sprites according to a choosen method.

See also

Align selected sprites according to a choosen method.

See also

Animate DiagramObjects using parameters defined through an array of Tweener objects

Applies a given function (processing logic) to the anchors of a DiagramObject instance given function parameters and according to a filter function and its parameters if defined.

Applies a given function (processing logic) to DiagramPanelsContainer children of this DiagramView given function parameters.

Check if a column can be closed. This function must be overriden if a control must be done before closing a column. Default behavious is to always accept to close a lane (ie function return always true.

Check if a lane can be closed. This function must be overriden if a control must be done before closing a lane. Default behavious is to always accept to close a lane (ie function return always true.

Check if a panel can be closed. This function must be overriden if a control must be done before closing a panel. Default behavious is to always accept to close a panel (ie function return always true.

Check is existing sprite can be inserted upon DiagramLink

Zooms and scrolls the view, the focus point beeing on the center of the viewport

Check if a diagram element property can change. It use the model to retreive the IObjectProxy for the element, and call the acceptPropertyModification() method of the proxy. This mecanism enable developpers to prevent user to change some properties.

See also

Check if a diagram element can be remove. It uses the model to retreive the IObjectProxy for the element, and call the acceptRemoveObject() method of the proxy. This mecanism enable developpers to prevent user to delete some diagram element.

See also

Checks if an XML description is adequate to this DiagramView instance by checking the tag name property.

Clears all embedded references to IDiagramElements of this DiagramView

Inflicts the effect of a DiagramColumn removal on this DiagramView.

Count all object in the DiagramView of the given class, using an optional filter function.

Counts all selected Diagram Objects inside this DiagramView.

Creates a DiagramAnnotation to be attached to a DiagramObject and returns it.

Creates DiagramView children. They are listed as follows:

• UI Layer
• Panels : a DiagramPanelsContainer

Create a composition between a master (composite) and an slave (composition element).

Creates a DiagramLink between a source and a target DiagramObject while respecting the control points and returns it.

Creates a DiagramSprite at a defined position, given its ID and returns it. The creation of this DiagramSprite can be optionnaly made with consideration of centered drawing.

Creates sprite upon diagramLink, at a given point

Remove all Diagram Objects from current selection inside the DiagramView. If any object was selected, a DiagramEvent.SELECTION_CHANGE will be dispatched.

Finalizes the dragging process by creating the selected DiagramSprite (dragged item) at the Drag Drop position.

Enables dragging items referring to DiagramObjects from this DiagramView drag source. This function initialises the dragging process. Each dragged item must be accepted by the DragManager.

Sets the feedback indicator for the drag and drop operation to a Copy action. When dragging this function copies the dragged item and do not move it.

Parses this DiagramView from an XML object.

See also

Returns the Diagram Lane, belonging to this DiagramView, under a given point. It is used to enable Diagram Lane selection inside this DiagramView component.

Returns the DiagramObject, belonging to this DiagramView, under a given point. It is used to enable Diagram Object selection inside a DiagramView component regardless of its Diagram Panel container.

Get a bound to be used with Sprite.startDrag().

See also

Search for a diagram element linked to a given dataobjectid.

See also

Search for a diagram element that has a given did.

See also

Returns the index of a DiagramLane embedded in this DiagramView.

Returns in and out Links of a Sprites selection.

Returns link under sprite (if found), by looping the links collection

Returns object of the searched class under sprite (if found), by looping the object collection

Retrieve all object in the DiagramView of the given class, using an optional filter function.

Returns the index of a DiagramPanel embedded in this DiagramView.

Returns the minimum points mandatory to create a link between 2 diagramObjects

Returns a registered IDiagramElement given its ID (reference key).

Return all selected object

Returns sprite under sprite (if found), by looping the sprite collection

Returns This DiagramView tagname equal to "diagram".

Allows grouping selected objects in a DiagramGroup instance.

Check if the diagram contains an object.

Hides the feedback effect on all Links

Hides the feedback effect on all Sprites

Inserts a DiagramColumn at a given index and returns it. It is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DiagramView.

Inserts existing sprite upon DiagramLink

Inserts a DiagramLane at a given index inside a DiagramPanel of this DiagramView and returns it. It is added at the index position specified. An index of 0 represents the back (bottom) of the display list for the DiagramPanel panel.

Inserts a DiagramPanel at a given index and returns it. It is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DiagramView.

Check if an animation is currently playing

Inflicts the effect of a DiagramLane removal on this DiagramView.

Redraws this DiagramView and its children when library styles and assets change given a SVGAssetLibraryEvent. The redraw action affects directly its DiagramPanelsContainer.

Move an object on top of its layer. It will cover of other objects of its layer.

Notify application that a diagram object changed of column

Dispatch event to ask for an asynchronous column creation. Called if asynccolumncreation is true

See also

Notify application of an element affilation.

See also

Notify application of an element creation.

Notify application of an element load. Called after fromXML().

See also

Notify application of an element move.

Notify application that a element property changed

Notify application of an element removal.

This methode is used to notify all elements loading. It is called at the end of fromXML method. It recursivelly calls panels and lanes and leads to call of notifyElementLoaded for each diagram element.

See also

Notify application that a diagram object changed of lane

Dispatch event to ask for an asynchronous lane creation. Called if asynclanecreation is true

See also

Notify application of an link scope change.

Dispatch event to ask for an asynchronous panel creation. Called if asyncpanelcreation is true

See also

Inflicts the change of a source Layer and a target Layer on the DiagramView.

Inflicts the effect of a DiagramObject removal on this DiagramView.

Inflicts the effect of a DiagramPanel removal on this DiagramView.

Pends a link path animation to a tweeners array.

Registers a Diagram Action to be considered by the different parts of this DiagramView.

Registers a IDiagramElement reference in this DiagramView using its ID as key. This aims at having fast access to the different Diagram Elements embedded inside this DiagramView.

Registers a Diagram Tool to be used by the different parts of this DiagramView.

Removes all Diagram Objects inside this DiagramView.

Remove links between source and target

Removes an object inside this DiagramView.

Removes a DiagramPanel at a specified index. This index refers to the DiagramPanel position in the children list of DiagramView's DiagramPanelsContainer.

Removes all selected Diagram Objects inside this DiagramView.

Return to default mode. Reset linkMode, handMode, transformMode.

See also

Scroll view position without animation

Scroll to a new position with animation.

Selects all Diagram Objects inside the DiagramView. If any object was not selected, a DiagramEvent.SELECTION_CHANGE will be dispatched.

Select or deselects a given DiagramObject inside this DiagramView and optionally dispatches a mouse event after selection or deselection is performed. If the object selected state changed, a DiagramEvent.SELECTION_CHANGE will be dispatched.

Selects all Diagram Objects of this DiagramView, contained inside a given Rectangle. This function can be used for multiple selection. If any object inside rectangle was not selected, a DiagramEvent.SELECTION_CHANGE will be dispatched.

Hightlights the link and disable feedback effect on all the others

Stops any pending DiagramObjects animation

Detects changes to style properties and handle the change accordingly. When any style property is set, Flex calls the styleChanged method, passing to it the name of the style being set.

Ask to all the Diagram elements to synchronize all reference after they have been loaded from XML. This function is called by fromXLM() function.

See also

Adds mouse listeners and allows required actions for all DiagramSprite objects. Called after a linkMode change.

See also

Exports this DiagramView instance (edited diagram) to an SVG file by writing in an SVGSVGElement instance and calling the appendToSVGDocument method.

Writes this DiagramView into an XML document. The XML document will follow this schema :

     <?xml version="1.0" encoding="utf-8"?>
     <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
     <xs:complexType name="diagramObject" mixed="true">
     <xs:sequence minOccurs="0" maxOccurs="unbounded">
     <xs:element name="anchor" type="diagramAnchor" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dataid" type="xs:string" use="optional" />
     <xs:attribute name="selected" type="xs:boolean" use="optional" />
     <xs:attribute name="grouped" type="xs:boolean" use="optional" />
     <xs:attribute name="layer" type="xs:string" use="optional" />
     <xs:attribute name="master" type="xs:string" use="optional" />
     <xs:attribute name="annotation" type="xs:string" use="optional" />
     <xs:attribute name="selectable" type="xs:boolean" use="optional" />
     <xs:attribute name="resizeenabled" type="xs:boolean" use="optional" />
     <xs:attribute name="compositebounds" type="xs:string" use="optional" />
     <xs:attribute name="compositionboundindex" type="xs:integer" use="optional" />
     </xs:complexType>

     <xs:complexType name="diagramAnchor">
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dx" type="xs:float" use="required" />
     <xs:attribute name="dy" type="xs:float" use="required" />
     <xs:attribute name="target" type="xs:string" use="required" />
     </xs:complexType>

     <xs:complexType name="diagramSprite" mixed="true">
     <xs:complexContent>
     <xs:extension base="diagramObject">
     <xs:sequence>
     <xs:sequence minOccurs="0">
     <xs:element name="textfield">
     <xs:complexType>
     <xs:simpleContent>
     <xs:extension base="xs:string">
     <xs:attribute name="shapeid" type="xs:string" use="required" />
     </xs:extension>
     </xs:simpleContent>
     </xs:complexType>
     </xs:element>
     </xs:sequence>
     <xs:element name="svgmodifs" minOccurs="0">
     <xs:complexType>
     <xs:sequence minOccurs="0" maxOccurs="unbounded">
     <xs:element name="path" minOccurs="0">
     <xs:complexType>
     <xs:attribute name="id" type="xs:string" use="required"/>
     <xs:attribute name="commands" type="xs:string" use="required"/>
     </xs:complexType>
     </xs:element>
     <xs:element name="viewport" minOccurs="0">
     <xs:complexType>
     <xs:attribute name="id" type="xs:string"/>
     <xs:attribute name="width" type="xs:float" use="required"/>
     <xs:attribute name="height" type="xs:float" use="required"/>
     </xs:complexType>
     </xs:element>
     <xs:element name="element" minOccurs="0">
     <xs:complexType>
     <xs:attribute name="id" type="xs:string" use="required"/>
     <xs:attribute name="x" type="xs:float" use="required"/>
     <xs:attribute name="y" type="xs:float" use="required"/>
     </xs:complexType>
     </xs:element>
     </xs:sequence>
     </xs:complexType>
     </xs:element>

     </xs:sequence>
     <xs:attribute name="dx" type="xs:float" use="optional" />
     <xs:attribute name="dy" type="xs:float" use="optional" />
     <xs:attribute name="box" type="xs:string" use="required" />
     <xs:attribute name="dragenabled" type="xs:boolean" use="optional" />
     <xs:attribute name="spriteid" type="xs:string" use="required" />
     </xs:extension>
     </xs:complexContent>
     </xs:complexType>

     <xs:complexType name="diagramGroup">
     <xs:sequence>
     <xs:element maxOccurs="unbounded" name="sprite" type="diagramSprite" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="box" type="xs:string" use="required" />
     </xs:complexType>

     <xs:complexType name="diagramLink">
     <xs:complexContent>
     <xs:extension base="diagramObject">
     <xs:attribute name="behaviour" type="xs:integer" use="required" />
     <xs:attribute name="geometry" type="xs:integer" use="required" />
     <xs:attribute name="styleclass" type="xs:string" use="required" />
     <xs:attribute name="x" type="xs:float" use="required"/>
     <xs:attribute name="y" type="xs:float" use="required"/>
     <xs:attribute name="points" type="xs:string" use="optional" />
     <xs:attribute name="target" type="xs:string" use="optional" />
     </xs:extension>
     </xs:complexContent>
     </xs:complexType>

     <xs:complexType name="diagramAnnotation">
     <xs:complexContent>
     <xs:extension base="diagramSprite" />
     </xs:complexContent>
     </xs:complexType>

     <xs:complexType name="diagramLinkAnnotation">
     <xs:complexContent>
     <xs:extension base="diagramSprite">
     <xs:attribute name="segmentindex" type="xs:integer" />
     </xs:extension>
     </xs:complexContent>
     </xs:complexType>

     <xs:complexType name="diagramLinksLayer">
     <xs:sequence minOccurs="0">
     <xs:element name="link" type="diagramLink" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dataid" type="xs:string" use="optional" />
     </xs:complexType>

     <xs:complexType name="diagramLinksAnnotationsLayer">
     <xs:sequence minOccurs="0">
     <xs:element name="linkannotation" type="diagramLinkAnnotation" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dataid" type="xs:string" use="optional" />
     </xs:complexType>

     <xs:complexType name="diagramSpritesLayer">
     <xs:sequence minOccurs="0" maxOccurs="unbounded">
     <xs:element minOccurs="0" name="group" type="diagramGroup" />
     <xs:element minOccurs="0" name="sprite" type="diagramSprite" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     </xs:complexType>

     <xs:complexType name="diagramAnnotationsLayer">
     <xs:sequence minOccurs="0">
     <xs:element name="annotation" type="diagramAnnotation" />
     <xs:element name="linkannotation" type="diagramLinkAnnotation" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     </xs:complexType>

     <xs:complexType name="diagramLane">
     <xs:sequence>
     <xs:element name="links" type="diagramLinksLayer" />
     <xs:element name="sprites" type="diagramSpritesLayer" />
     <xs:element name="annotations" type="diagramAnnotationsLayer" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dataid" type="xs:string" use="optional" />
     <xs:attribute name="height" type="xs:float" use="required" />
     <xs:attribute name="storedheight" type="xs:float" use="optional" />
     <xs:attribute name="expandedheight" type="xs:float" use="optional" />
     <xs:attribute name="title" type="xs:string" use="optional" />
     </xs:complexType>

     <xs:complexType name="diagramPanel">
     <xs:sequence>
     <xs:element maxOccurs="unbounded" name="lane" type="diagramLane" />
     <xs:element name="links" type="diagramLinksLayer" />
     <xs:element name="annotations" type="diagramLinksAnnotationsLayer" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dataid" type="xs:string" use="optional" />
     <xs:attribute name="height" type="xs:unsignedShort" use="required" />
     <xs:attribute name="title" type="xs:string" use="required" />
     </xs:complexType>

     <xs:complexType  name="diagramPanelContainer">
     <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="unbounded" name="panel" type="diagramPanel" />
     <xs:element name="links" type="diagramLinksLayer" />
     <xs:element name="annotations" type="diagramLinksAnnotationsLayer" />
     </xs:sequence>
     <xs:attribute name="id" type="xs:string" use="required" />
     <xs:attribute name="dataid" type="xs:string" use="optional" />
     </xs:complexType>

     <xs:element name="diagram">
     <xs:complexType>
     <xs:sequence minOccurs ="0" maxOccurs="1">
     <xs:element name="panels" type="diagramPanelContainer" />
     </xs:sequence>
     <xs:attribute name="version" type="xs:integer" use="required" />
     <xs:attribute name="width" type="xs:float" use="required" />
     <xs:attribute name="height" type="xs:float" use="required" />
     <xs:attribute name="id" type="xs:string" use="required" />
     </xs:complexType>
     </xs:element>

     </xs:schema>
     

See also

Ungroups selected DiagramGroup instances.

Unreegisters a Diagram Action considered by the different parts of this DiagramView.

Unregisters a Diagram Tool used by the different parts of this DiagramView.

Draws the DiagramView and/or sizes and positions its children. This method is called when the component is added to a container using the addChild() method, and when the component's invalidateDisplayList() method is called.

Dispatched when a column caption is double clicked.

Dispatched when default mode is set.

Dispatched when a group is created.

Dispatched when a group is deleted.

Dispatched when hand mode is set.

Dispatched when a lane caption is double clicked.

Dispatched when link mode is set.

Dispatched when the diagram is modified.

Dispatched when a panel caption is double clicked.

Dispatched when transform mode is set.

Dispatched when zoom mode is set.

Dispatched when the user moves around the mouse while a drag operation is pending

Dispatched after the drag operation has completed and before the ungroup of the selection

Dispatched after the drag operation has completed and after the ungroup of the selection

Dispatched when the user initiates a drag operation

Dispatched when an element is added to the diagram.

Dispatched when an element is loaded from XML into the diagrammer.

Dispatched when an element of the diagram is moved.

Dispatched when an element property is modified.

Dispatched when the whole selection is removed from the diagram.

Dispatched when the user has finished resizing an element.

Dispatched while an element is resized.

Dispatched when an element start to be resized by the user.

Dispatched when an asynchronouslane creation request occurs.

Dispatched when a link scope changed.

Dispatched when an asynchronous panel creation request occurs.

Dispatched when the selection of objects in the diagram changed.

Dispatched when a sprite is moved from one lane to another.

Default height of the SVG representation of this DiagramView.

See also

Default width of the SVG representation of this DiagramView.

See also

Horizontal center alignement

See also

Horizontal left alignement

See also

Horizontal right alignement

See also

Horizontal distribution of center

See also

Horizontal distribution of left

See also

Horizontal distribution of right

See also

Horizontal event spacing

See also

Link can be created using link zone on SVG library

See also

Link are created manually by clicking on sprites.

See also

Link can not be created. Used to disable linking using link zone

See also

Vertical bottom alignement

See also

Vertical center alignement

See also

Vertical top alignement

See also

Vertical distribution of bottom

See also

Vertical distribution of center

See also

Vertical distribution of top

See also

Vertical even spacing

See also