Packagecom.kapit.diagram.view
Classpublic class DiagramLink
InheritanceDiagramLink Inheritance DiagramObject Inheritance mx.core.UIComponent
ImplementsISVGExportable



Public Properties
 PropertyDefined by
 Inheritedallowannotation : Boolean
Indicates whether annotation is allowed for this DiagramObject.
DiagramObject
 Inheritedallowcomposite : Boolean
Indicates whether this DiagramObject can be a composite (holding composition members).
DiagramObject
 Inheritedallowcomposition : Boolean
Indicates whether this DiagramObject can be part of a composition.
DiagramObject
  allowgrouping : Boolean
[read-only] Indicates whether this DiagramLink can be added to a DiagramGroup or not.
DiagramLink
 Inheritedallowinputlinks : Boolean
Indicates whether input links are allowed for this DiagramObject.
DiagramObject
 Inheritedallowoutputlinks : Boolean
Indicates whether output links are allowed for this DiagramObject.
DiagramObject
  allowpointdelete : Boolean
[read-only] Indicates whether it is permitted to delete points from the points array.
DiagramLink
  allowpointinsert : Boolean
[read-only] Indicates whether it is permitted to insert points to the points array.
DiagramLink
 Inheritedanchors : Array
An array containing the AnchorPoints of this DiagramObject.
DiagramObject
 Inheritedannotation : DiagramAnnotation
DiagramAnnotation belonging to this DiagramObject.
DiagramObject
 InheritedcanShowLinkBar : Boolean
DiagramObject
 Inheritedcolumn : DiagramColumn
Diagram Column to which this DiagramObject belongs.
DiagramObject
 InheritedcompositionBoundIndex : int
Position of object in composition.
DiagramObject
 InheritedcompositionElements : int
DiagramObject
 Inheritedcurrentcolumn : DiagramColumn
The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .
DiagramObject
 Inheritedcurrentscope : DiagramLane
The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .
DiagramObject
  dashOffsets : Array
Dashed Array Offsets
DiagramLink
 Inheriteddataobjectid : String
Data object id of the diagram object.
DiagramObject
 Inheriteddid : String
The diagram unique identifier of this DiagramObject.
DiagramObject
 Inheriteddragenabled : Boolean
Tells if the diagram object is drag enabled.
DiagramObject
 Inheriteddragging : Boolean
Indicates whether this DiagramObject is currently being dragged.
DiagramObject
  feedbackstyleselector : String
Name of the style selector to be used to render this DiagramLink in feedback mode
DiagramLink
  grouped : Boolean
[write-only] Indicates whether this DiagramObject belongs to a DiagramGroup.
DiagramLink
 Inheritedinnerbottom : Number
DiagramObject
  innerbox : Rectangle
[read-only] The rectangle specified by the innerleft, innertop, innerwidth and innerheight properties and obtained by calling the computeBox() method.
DiagramLink
 Inheritedinnercenter : Point
DiagramObject
  innerheight : Number
[read-only] The inner height of this DiagramLink.
DiagramLink
  innerleft : Number
[read-only] The inner left position (X coordinate).
DiagramLink
 Inheritedinnerright : Number
DiagramObject
  innertop : Number
[read-only] The inner top position (Y coordinate).
DiagramLink
  innerwidth : Number
[read-only] The inner width of this DiagramLink.
DiagramLink
 Inheritedinnerxcenter : Number
DiagramObject
 Inheritedinnerycenter : Number
DiagramObject
 Inheritedinputlinks : Array
DiagramObject
 Inheritedlane : DiagramLane
The DiagagramLane that contains thsi DiagramObject.
DiagramObject
  lanescope : Boolean
[read-only] Indicates whether the parent of the layer containing this DiagramLink is a DiagramLane.
DiagramLink
  LANESCOPE : String = "lane"
[static]
DiagramLink
  layer : DiagramLayer
[write-only] The DiagramLayer that contains this DiagramLink.
DiagramLink
  lineColor : Number
DiagramLink
  lineOpacity : Number
DiagramLink
  lineWidth : Number
DiagramLink
  linktype : DiagramLinkType
DiagramLink
 Inheritedloading : Boolean
Indicates whether the DiagramObject is currently loading.
DiagramObject
 Inheritedmaster : AnchorPoint
Master AnchorPoint of this DiagramObject.
DiagramObject
 Inheritedmasterobject : DiagramObject
Master DiagramObject to which the master AnchorPoint depends.
DiagramObject
 InheritedmoveInsideMaster : Boolean
If true, the object must move inside his master innerbox.
DiagramObject
 Inheritedoutputlinks : Array
DiagramObject
  panelscope : Boolean
[read-only] Indicates whether the parent of the layer containing this DiagramLink is a DiagramPanel.
DiagramLink
  PANELSCOPE : String = "panel"
[static]
DiagramLink
  points : Array
An array containing this list of the control points of this DiagramLink.
DiagramLink
 Inheritedresizeenabled : Boolean
Tells if the diagram object is resize enabled.
DiagramObject
 InheritedscaleAsMaster : Boolean
If true, the object scale as his master.
DiagramObject
  scope : String
[read-only]
DiagramLink
 Inheritedselectable : Boolean
Tells if the diagram object is selectable.
DiagramObject
 Inheritedselected : Boolean
Indicates whether this DiagramObject is currently selected.
DiagramObject
  source : AnchorPoint
[read-only] The AnchorPoint that attaches this DiagramLink to its master DiagramObject.
DiagramLink
  sourceobject : DiagramObject
[read-only] The master DiagramObject of this DiagramLink.
DiagramLink
 Inheritedsprite : Sprite
This DiagramObject casted as Sprite instance.
DiagramObject
 InheritedstayInsideMaster : Boolean
If true, the object must stay inside his master innerbox.
DiagramObject
  styleselector : String
Name of the style selector to be used to render this DiagramLink.
DiagramLink
  target : AnchorPoint
[read-only] The AnchorPoint that attaches this DiagramLink to its target DiagramObject.
DiagramLink
  targetobject : DiagramObject
[read-only] The target DiagramObject of this DiagramLink.
DiagramLink
 Inheritedtoplevelgroup : DiagramGroup
The top level DiagramGroup in which this DiagramObject is embedded.
DiagramObject
  toplevelsourceobject : DiagramObject
[read-only]
DiagramLink
  topleveltargetobject : DiagramObject
[read-only]
DiagramLink
 InheritedtransformUILocked : Boolean
DiagramObject
 Inheritedui : DiagramObjectUI
The DiagramObjectUI controlling this DiagramObject.
DiagramObject
 Inheritedview : DiagramView
The DiagramView that contains this DiagramObject.
DiagramObject
  viewscope : Boolean
[read-only] Indicates whether the parent of the layer containing this DiagramLink is the DiagramPanelsContainer of the current DiagramView.
DiagramLink
  VIEWSCOPE : String = "view"
[static]
DiagramLink
 Inheritedx : Number
The absolute horizontal coordinate of this DiagramObject.
DiagramObject
 Inheritedy : Number
The absolute vertical coordinate of this DiagramObject.
DiagramObject
Protected Properties
 PropertyDefined by
 Inherited_allowannotation : Boolean = true
Indicates whether annotation is supported by this DiagramObject.
DiagramObject
 Inherited_allowcomposite : Boolean = false
Indicates whether this DiagramObject can be a composite (result of a composition of objects).
DiagramObject
 Inherited_allowcomposition : Boolean = false
Indicates whether this DiagramObject can be a member of a composition.
DiagramObject
 Inherited_allowinputlinks : Boolean = true
Indicates whether input links are allowed for this DiagramObject.
DiagramObject
 Inherited_allowoutputlinks : Boolean = true
Indicates whether output links are allowed for this DiagramObject.
DiagramObject
 Inherited_anchors : Object = null
Array of DiagramLink linked to this DiagramObject
DiagramObject
 Inherited_annotation : DiagramAnnotation = null
Annotation attached to this DiagramObject.
DiagramObject
 Inherited__annotationid : String = "null"
Annotation ID of this DiagramObject where this DiagramObject is a DiagramAnnotation.
DiagramObject
 Inherited_columnAffiliation : DiagramColumn
Diagram Column to which this DiagramObject belongs.
DiagramObject
 Inherited_compositeBounds : Array = null
DiagramObject
 Inherited_compositionBoundIndex : int = -1
DiagramObject
  _dashoffsets : Array
Offsets for dash line drawing
DiagramLink
 Inherited_dragging : Boolean = false
Indicates whether this DiagramObject is curretly being dragged.
DiagramObject
  _feedbackstyleselector : String = ".feedback-link"
CSS style selector (defined in the library), feedback mode
DiagramLink
 Inherited_grouped : Boolean = false
Indicates whether this DiagramObject is a group.
DiagramObject
 Inherited_lastmatrix : Matrix = null
Last transformation matrix used to define the position and the size of this DiagramObject.
DiagramObject
 Inherited_layer : DiagramLayer = null
Layer in which this DiagramObject is embedded.
DiagramObject
 Inherited__layerid : String = "null"
Layer ID of this DiagramObject where this DiagramObject is a DiagramLayer.
DiagramObject
  _linecolor : Number
Used line color for drawing this DiagramLink.
DiagramLink
  _linecolordefault : Number
Color for the normal link behaviour
DiagramLink
  _linecolorfeedback : Number
Color for the link in feedback mode
DiagramLink
  _lineopacity : Number
Used line opacity for drawing this DiagramLink.
DiagramLink
  _linewidth : Number
Used line width for drawing this DiagramLink.
DiagramLink
  _linktype : DiagramLinkType = null
Behaviour, geometry, css style
DiagramLink
 Inherited_loading : Boolean = false
Indicates whether the DiagramObject is currently loading.
DiagramObject
  _markersize : Number = 5
Size of a control point graphical marker.
DiagramLink
 Inherited_master : AnchorPoint = null
Master anchor point of this DiagramObject used to anchor DiagramAnnotation and DiagramLink components.
DiagramObject
 Inherited__masterid : String = "null"
Master Anchor ID of this DiagramObject where this DiagramObject is a AnchorPoint.
DiagramObject
 Inherited_moveInsideMaster : Boolean = false
Indicates whether this DiagramObject move inside his master.
DiagramObject
 Inherited_ogrect : Rectangle = null
Original surrounding rectangle of the DiagramGroup to which this DiagramObject belongs.
DiagramObject
 Inherited_orect : Rectangle = null
Original surrounding rectangle of this DiagramObject.
DiagramObject
 Inherited_resizeenabled : Boolean = true
Indicates whether this DiagramObject is resizable.
DiagramObject
 Inherited__savedColumn : DiagramColumn = null
DiagramObject
 Inherited__savedlayer : DiagramLayer = null
Layer to which this DiagramObject belongs to without considering user runtime modifications.
DiagramObject
 Inherited_selectable : Boolean = true
Indicates whether this DiagramObject is selectable.
DiagramObject
 Inherited_selected : Boolean = false
Indicates whether this DiagramObject is selected.
DiagramObject
 Inherited_selectedByMouseOver : Boolean = false
true if object was selected by mouse over
DiagramObject
 Inherited_stayInsideMaster : Boolean = true
Indicates whether this DiagramObject stay inside his master.
DiagramObject
  _styleselector : String = ".lanescope-link"
CSS style selector (defined in the library)
DiagramLink
  _target : AnchorPoint = null
Target anchor point linking to a target DiagramObject.
DiagramLink
  __targetid : String = "null"
ID of the Target AnchorPoint.
DiagramLink
 Inherited_transformui : DiagramObjectUI = null
Transform UI that can be used only in transform mode.
DiagramObject
 Inherited_ui : DiagramObjectUI = null
DiagramObjectUI controlling this DiagramObject and used as an tool that user can interact with in order to customize this DiagramObject properties (links, size, styles...).
DiagramObject
 Inherited_view : DiagramView = null
Diagram View to which this DiagramObject belongs.
DiagramObject
 Inherited_x : Number
X coordinate of this DiagramObject.
DiagramObject
  _xgraphics : ExtendedGraphics
Extended graphics wrapper
DiagramLink
 Inherited_y : Number
Y coordinate of this DiagramObject.
DiagramObject
Public Methods
 MethodDefined by
  
Creates a new DiagramLink instance.
DiagramLink
 Inherited
activateTransformUI(a:Boolean):void
Activates or deactivates the Transform UI in Transform Mode.
DiagramObject
 Inherited
activateUI(a:Boolean):void
Activates or deactivates this DiagramObject.
DiagramObject
 Inherited
addChildAt(child:DisplayObject, idx:int):DisplayObject
DiagramObject
 Inherited
Removes an AnchorPoint from this DiagramObject AnchorPoints array.
DiagramObject
  
appendToSVGDocument(doc:SVGSVGElement):void
Adds this DiagramLink object in SVG format to an SVGSVGElement object.
DiagramLink
 Inherited
checkTagName(xml:XML):Boolean
Checks if an XML object tag name is equal to this DiagramObject tag name.
DiagramObject
 Inherited
cleanup():void
Cleans up listeners.
DiagramObject
 Inherited
DiagramObject
 Inherited
clearUI():void
Hides UI elements (knobs, link bar, etc) until next screen update
DiagramObject
 Inherited
Creates a new AnchorPoint having this DiagramObject as master and target as target.
DiagramObject
  
DiagramLink
  
doDrag(event:MouseEvent):void
Updates the position of the DiagramLink after the dragging action is finished.
DiagramLink
 Inherited
dragStarted(event:MouseEvent):void
Notifies the start of a dragging operation of this DiagramObject.
DiagramObject
 Inherited
dragStopped(event:MouseEvent):void
Notifies that the dragging operation of this DiagramObject is stopped and inflicts results to it.
DiagramObject
  
fromXML(xml:XML):void
Parses this DiagramLink from an XML object.
DiagramLink
  
DiagramLink
  
getClosestSegmentIndexFromPoint(testpoint:Point):int
DiagramLink
  
getIntersectionPointWithRectangle(rect:Rectangle):Point
Returns intersection point (if any) of diagramlink with given rectangle
DiagramLink
 Inherited
Returns an array of available groups of linkable Sprite IDs.
DiagramObject
  
DiagramLink
  
getSourceClipping(sprite:Sprite, pts:Array, global:Boolean):Object
Returns an object containing clipping information about a polyline object defined by its control points clipping with a Sprite object sprite considered as a source object of a DiagramLink polyline.
DiagramLink
  
getTagName():String
Returns This DiagramLink tagname equal to "link".
DiagramLink
  
getTargetClipping(sprite:Sprite, pts:Array):Object
Returns an object containing clipping information about a polyline object defined by its control points clipping with a Sprite object sprite considered as a target object of a DiagramLink polyline.
DiagramLink
 Inherited
grouping(group:DiagramGroup):void
Inflicts adding this DiagramObject to a DiagramGroup, to the original and original group rectangles by updating their values.
DiagramObject
 Inherited
groupSizing(w:Number, h:Number, update:Boolean = true):void
Inflicts DiagramGroup sizing to this DiagramObject if this DiagramObject belongs to that DiagramGroup.
DiagramObject
  
hideFeedBack():void
Hides feedback effect on link
DiagramLink
 Inherited
hitTest(p:Point, strict:Boolean = false, selectableOnly:Boolean = false):Boolean
Evaluates the DiagramObject to see if it overlaps or intersects with the specified point.
DiagramObject
 Inherited
hitTestUI(p:Point):int
Determines the Diagram hit type given a point (cursor hit position) meaning determining what the cursor hits.
DiagramObject
  
immediatlyUpdatePoints(a:Array):void
DiagramLink
  
init(s:DiagramObject = null, t:DiagramObject = null, pts:Array = null, lt:DiagramLinkType = null):void
Initialises this DiagramLink instance with the required link parameters.
DiagramLink
  
intersectsRect(rect:Rectangle):Boolean
Checks if orthogonal diagramLink intersects with rectangle
DiagramLink
 Inherited
isInsideRect(rect:Rectangle):Boolean
Indicates whether the DiagramObject is inside a given rectangle.
DiagramObject
  
Marks the DiagramLink component so that its updateDisplayList() method gets called during a later screen update to render the new library styles.
DiagramLink
 Inherited
linkCreated():void
DiagramObject
  
Changes the position of this DiagramLink component according to changes on the Target or Master AnchorPoint.
DiagramLink
  
Removes this DiagramLink from its parent container after that its Master DiagramObject has been removed and updates master or target Anchor point.
DiagramLink
 Inherited
masterUpdated(anchor:AnchorPoint, scaleX:Number = 1, scaleY:Number = 1):void
DiagramObject
 Inherited
Detects and notifies changes in the scope of this DiagramObject.
DiagramObject
 Inherited
redispatchEvent(event:Event):void
Redispatches a received event to the DiagramObjectUI controlling this DiagramObject _ui.
DiagramObject
 Inherited
releaseActionBounds(index:int):void
DiagramObject
 Inherited
setPlacement(rect:Rectangle, update:Boolean = true):void
Changes the location and size of this DiagramObject so that its innerbox property fits the specified rectangle.
DiagramObject
 Inherited
setPosition(px:Number, py:Number, silent:Boolean = false):void
Adjusts the location of the DiagramObject, as determined by its top-left corner, to the specified position and calls the updateAnchorsPlacement() and updateScope() methods.
DiagramObject
  
showFeedBack():void
Shows feedback effect on link
DiagramLink
  
DiagramLink
  
toXML():XML
Writes this DiagramLink into an XML object.
DiagramLink
  
uiCompleted():void
Finalizes modifications on this DiagramLink, transmitted by its DiagramLinkUI.
DiagramLink
 Inherited
Inflicts removing this DiagramObject from a DiagramGroup, to the original and original group rectangles.
DiagramObject
  
unlink():void
Removes all link references (master and target anchor points) of this DiagramLink.
DiagramLink
 Inherited
unregister():void
DiagramObject
 Inherited
updateAnchorsPlacement(newbox:Rectangle = null, oldbox:Rectangle = null):void
Updates the placement of all the anchors attached to this DiagramObject after it has been resized.
DiagramObject
  
DiagramLink
  
updateColumnScope(fitContent:Boolean = true):void
Updates Column Scope.
DiagramLink
 Inherited
Updates the placement of the DiagramLink objects linked to this DiagramObject.
DiagramObject
 Inherited
Updates links of this DiagramObject according to its scope by applying the updateScope() method on each of its anchors.
DiagramObject
  
updateScope():void
Detects changes in dependancy toward the container of this DiagramLink, due to user modificatiosn on the source and target DiagramObject components, and updates it.
DiagramLink
  
updateStyle():void
Updates style properties of this DiagramLink.
DiagramLink
 Inherited
updateUI():void
Marks this DiagramObject so that its updateDisplayList() method gets called during a later screen update.
DiagramObject
  
updateUILayer(sourcelayer:DiagramLayer, targetlayer:DiagramLayer):void
Inflicts changes in the source layer and target layer on the container (DiagramLane or DiagramPanel) of the DiagramLinkUI _ui controlling this DiagramLink.
DiagramLink
Protected Methods
 MethodDefined by
  
applyTransform(matrix:Matrix, update:Boolean = true):void
Applies the transformation matrix matrix to this DiagramLink component.
DiagramLink
  
computeBox(target:DisplayObject = null):Rectangle
Determines the rectangle that contains this DiagramLink.
DiagramLink
 Inherited
Creates the TransformUI controlling this DiagramObject component.
DiagramObject
 Inherited
Creates the DiagramObjectUI controlling this DiagramObject component.
DiagramObject
  
draw():void
Draws this DiagramLink elements (control points as circles, H/V lines connecting control points, link arrow, source and target markers...) while respecting control points and style properties.
DiagramLink
  
drawPolyline(polyline:Array):void
DiagramLink
  
drawQuadrics(polyline:Array):void
DiagramLink
 Inherited
getLinks(input:Boolean):Array
Returns DiagramLinks whose source or target is this object
DiagramObject
  
Called after this DiagramLink has been added to its parent layer
DiagramLink
  
Adds a third point to the points array if it contains only two points.
DiagramLink
  
Transforms the points array into an array of three points by keeping only the first and last points and adding a third one in the middle.
DiagramLink
  
Marks the DiagramLink component so that its updateDisplayList() method gets called during a later screen update to render the new system library styles.
DiagramLink
  
updateDisplayList(w:Number, h:Number):void
Draws the DiagramLink and/or sizes and positions its children.
DiagramLink
  
Changes the position of this DiagramLink component according to changes on the Target or Master AnchorPoint.
DiagramLink
  
Modifies the UI class (a DiagramLinkUI subclass) according to this DiagramLink's behaviour
DiagramLink
Property detail
allowgroupingproperty
allowgrouping:Boolean  [read-only]

Indicates whether this DiagramLink can be added to a DiagramGroup or not. A diagramLink can be grouped only if its master and target DiagramObjects are selected.

Implementation
    public function get allowgrouping():Boolean
allowpointdeleteproperty 
allowpointdelete:Boolean  [read-only]

Indicates whether it is permitted to delete points from the points array.

Implementation
    public function get allowpointdelete():Boolean
allowpointinsertproperty 
allowpointinsert:Boolean  [read-only]

Indicates whether it is permitted to insert points to the points array.

Implementation
    public function get allowpointinsert():Boolean
_dashoffsetsproperty 
protected var _dashoffsets:Array

Offsets for dash line drawing

dashOffsetsproperty 
dashOffsets:Array  [read-write]

Dashed Array Offsets

Implementation
    public function get dashOffsets():Array
    public function set dashOffsets(value:Array):void
_feedbackstyleselectorproperty 
protected var _feedbackstyleselector:String = ".feedback-link"

CSS style selector (defined in the library), feedback mode

feedbackstyleselectorproperty 
feedbackstyleselector:String  [read-write]

Name of the style selector to be used to render this DiagramLink in feedback mode

Implementation
    public function get feedbackstyleselector():String
    public function set feedbackstyleselector(value:String):void
groupedproperty 
grouped:Boolean  [write-only]

Indicates whether this DiagramObject belongs to a DiagramGroup.

Implementation
    public function set grouped(value:Boolean):void
innerboxproperty 
innerbox:Rectangle  [read-only]

The rectangle specified by the innerleft, innertop, innerwidth and innerheight properties and obtained by calling the computeBox() method.

Implementation
    public function get innerbox():Rectangle
innerheightproperty 
innerheight:Number  [read-only]

The inner height of this DiagramLink.

Implementation
    public function get innerheight():Number
innerleftproperty 
innerleft:Number  [read-only]

The inner left position (X coordinate).

Implementation
    public function get innerleft():Number
innertopproperty 
innertop:Number  [read-only]

The inner top position (Y coordinate).

Implementation
    public function get innertop():Number
innerwidthproperty 
innerwidth:Number  [read-only]

The inner width of this DiagramLink.

Implementation
    public function get innerwidth():Number
lanescopeproperty 
lanescope:Boolean  [read-only]

Indicates whether the parent of the layer containing this DiagramLink is a DiagramLane.

Implementation
    public function get lanescope():Boolean
LANESCOPEproperty 
public static var LANESCOPE:String = "lane"
layerproperty 
layer:DiagramLayer  [write-only]

The DiagramLayer that contains this DiagramLink.

Implementation
    public function set layer(value:DiagramLayer):void
_linecolorproperty 
protected var _linecolor:Number

Used line color for drawing this DiagramLink.

lineColorproperty 
lineColor:Number  [read-write]Implementation
    public function get lineColor():Number
    public function set lineColor(value:Number):void
_linecolordefaultproperty 
protected var _linecolordefault:Number

Color for the normal link behaviour

_linecolorfeedbackproperty 
protected var _linecolorfeedback:Number

Color for the link in feedback mode

_lineopacityproperty 
protected var _lineopacity:Number

Used line opacity for drawing this DiagramLink.

lineOpacityproperty 
lineOpacity:Number  [read-write]Implementation
    public function get lineOpacity():Number
    public function set lineOpacity(value:Number):void
_linewidthproperty 
protected var _linewidth:Number

Used line width for drawing this DiagramLink.

lineWidthproperty 
lineWidth:Number  [read-write]Implementation
    public function get lineWidth():Number
    public function set lineWidth(value:Number):void
_linktypeproperty 
protected var _linktype:DiagramLinkType = null

Behaviour, geometry, css style

linktypeproperty 
linktype:DiagramLinkType  [read-write]Implementation
    public function get linktype():DiagramLinkType
    public function set linktype(value:DiagramLinkType):void
_markersizeproperty 
protected var _markersize:Number = 5

Size of a control point graphical marker.

panelscopeproperty 
panelscope:Boolean  [read-only]

Indicates whether the parent of the layer containing this DiagramLink is a DiagramPanel.

Implementation
    public function get panelscope():Boolean
PANELSCOPEproperty 
public static var PANELSCOPE:String = "panel"
pointsproperty 
points:Array  [read-write]

An array containing this list of the control points of this DiagramLink.

Implementation
    public function get points():Array
    public function set points(value:Array):void
scopeproperty 
scope:String  [read-only]Implementation
    public function get scope():String
sourceproperty 
source:AnchorPoint  [read-only]

The AnchorPoint that attaches this DiagramLink to its master DiagramObject.

Implementation
    public function get source():AnchorPoint
sourceobjectproperty 
sourceobject:DiagramObject  [read-only]

The master DiagramObject of this DiagramLink.

Implementation
    public function get sourceobject():DiagramObject
_styleselectorproperty 
protected var _styleselector:String = ".lanescope-link"

CSS style selector (defined in the library)

styleselectorproperty 
styleselector:String  [read-write]

Name of the style selector to be used to render this DiagramLink.

Implementation
    public function get styleselector():String
    public function set styleselector(value:String):void
_targetproperty 
protected var _target:AnchorPoint = null

Target anchor point linking to a target DiagramObject.

targetproperty 
target:AnchorPoint  [read-only]

The AnchorPoint that attaches this DiagramLink to its target DiagramObject.

Implementation
    public function get target():AnchorPoint
__targetidproperty 
protected var __targetid:String = "null"

ID of the Target AnchorPoint.

targetobjectproperty 
targetobject:DiagramObject  [read-only]

The target DiagramObject of this DiagramLink.

Implementation
    public function get targetobject():DiagramObject
toplevelsourceobjectproperty 
toplevelsourceobject:DiagramObject  [read-only]

Implementation
    public function get toplevelsourceobject():DiagramObject
topleveltargetobjectproperty 
topleveltargetobject:DiagramObject  [read-only]

Implementation
    public function get topleveltargetobject():DiagramObject
viewscopeproperty 
viewscope:Boolean  [read-only]

Indicates whether the parent of the layer containing this DiagramLink is the DiagramPanelsContainer of the current DiagramView.

Implementation
    public function get viewscope():Boolean
VIEWSCOPEproperty 
public static var VIEWSCOPE:String = "view"
_xgraphicsproperty 
protected var _xgraphics:ExtendedGraphics

Extended graphics wrapper

Constructor detail
DiagramLink()constructor
public function DiagramLink(view:DiagramView)

Creates a new DiagramLink instance.

Parameters
view:DiagramView — The DiagramView that contains this DiagramLink.
Method detail
appendToSVGDocument()method
public function appendToSVGDocument(doc:SVGSVGElement):void

Adds this DiagramLink object in SVG format to an SVGSVGElement object.

Parameters
doc:SVGSVGElement — SVGSVGElement to be updated by adding this DiagramLink object.
applyTransform()method 
protected override function applyTransform(matrix:Matrix, update:Boolean = true):void

Applies the transformation matrix matrix to this DiagramLink component.

Parameters
matrix:Matrix — A transformation matrix.
 
update:Boolean (default = true)
computeBox()method 
protected function computeBox(target:DisplayObject = null):Rectangle

Determines the rectangle that contains this DiagramLink.

Parameters
target:DisplayObject (default = null)

Returns
Rectangle — The rectangle that contains this DiagramLink.
createAnnotation()method 
public override function createAnnotation():DiagramAnnotation

Returns
DiagramAnnotation
doDrag()method 
public override function doDrag(event:MouseEvent):void

Updates the position of the DiagramLink after the dragging action is finished.

Parameters
event:MouseEvent — A MouseEvent.
draw()method 
protected function draw():void

Draws this DiagramLink elements (control points as circles, H/V lines connecting control points, link arrow, source and target markers...) while respecting control points and style properties.

drawPolyline()method 
protected function drawPolyline(polyline:Array):voidParameters
polyline:Array
drawQuadrics()method 
protected function drawQuadrics(polyline:Array):voidParameters
polyline:Array
fromXML()method 
public override function fromXML(xml:XML):void

Parses this DiagramLink from an XML object.

Parameters
xml:XML — An XML object represeting this DiagramLink.
getAnnotationLayer()method 
public function getAnnotationLayer():DiagramLayer

Returns
DiagramLayer
getClosestSegmentIndexFromPoint()method 
public function getClosestSegmentIndexFromPoint(testpoint:Point):intParameters
testpoint:Point

Returns
int
getIntersectionPointWithRectangle()method 
public function getIntersectionPointWithRectangle(rect:Rectangle):Point

Returns intersection point (if any) of diagramlink with given rectangle

Parameters
rect:Rectangle — Rectangle (global coordinates)

Returns
Point — intersection Point
getLinkPathInParentCoordinates()method 
public function getLinkPathInParentCoordinates():Array

Returns
Array
getSourceClipping()method 
public function getSourceClipping(sprite:Sprite, pts:Array, global:Boolean):Object

Returns an object containing clipping information about a polyline object defined by its control points clipping with a Sprite object sprite considered as a source object of a DiagramLink polyline. This method is used to enable drawing a DiagramLink polyline from a source Sprite

Parameters
sprite:Sprite — Sprite considered as the clipping object.
 
pts:Array — Array of polyline control points.
 
global:Boolean

Returns
Object — Object containing the following information:
  • Clip Index of the most close control point to the clip point, in this DiagramLink polyline control points array, clipidx
  • Clip point clipped
  • Start and End points,p0 and p1 of the segment of this DiagramLink polyline concerned with the clipping between this DiagramLink component and the Sprite sprite
getTagName()method 
public override function getTagName():String

Returns This DiagramLink tagname equal to "link".

Returns
String — This DiagramLink tagname.
getTargetClipping()method 
public function getTargetClipping(sprite:Sprite, pts:Array):Object

Returns an object containing clipping information about a polyline object defined by its control points clipping with a Sprite object sprite considered as a target object of a DiagramLink polyline. This method is used to enable drawing a DiagramLink polyline from a source Sprite

Parameters
sprite:Sprite — Sprite considered as the clipping object.
 
pts:Array — Array of polyline control points.

Returns
Object — Object containing the following information:
  • Clip Index of the most close control point to the clip point, in this DiagramLink polyline control points array, clipidx
  • Clip point clipped
  • Start and End points,p0 and p1 of the segment of this DiagramLink polyline concerned with the clipping between this DiagramLink component and the Sprite sprite
hideFeedBack()method 
public function hideFeedBack():void

Hides feedback effect on link

immediatlyUpdatePoints()method 
public function immediatlyUpdatePoints(a:Array):voidParameters
a:Array
init()method 
public function init(s:DiagramObject = null, t:DiagramObject = null, pts:Array = null, lt:DiagramLinkType = null):void

Initialises this DiagramLink instance with the required link parameters.

Parameters
s:DiagramObject (default = null) — Source DiagramObject instance from which the DiagramLink starts.
 
t:DiagramObject (default = null) — Target DiagramObject instance at which the DiagramLink ends.
 
pts:Array (default = null) — Control points of this DiagramLink that defines the shape of this DiagramLink as it is a combination of vertical and horizontal lines linked via these points.
 
lt:DiagramLinkType (default = null) — Defines behaviour, geometry and css style
intersectsRect()method 
public override function intersectsRect(rect:Rectangle):Boolean

Checks if orthogonal diagramLink intersects with rectangle

Parameters
rect:Rectangle

Returns
Booleantrue if the links intersects with given rectangle false otherwise.
libraryStylesChanged()method 
public override function libraryStylesChanged(event:SVGAssetLibraryEvent):void

Marks the DiagramLink component so that its updateDisplayList() method gets called during a later screen update to render the new library styles.

Parameters
event:SVGAssetLibraryEvent — An SVGAssetLibraryEvent event.
masterAnchorPointUpdated()method 
public override function masterAnchorPointUpdated(anchor:AnchorPoint):void

Changes the position of this DiagramLink component according to changes on the Target or Master AnchorPoint. This anchor point must be the source or target AnchorPoint of this DiagramLink in order to inflict updates on this DiagramLink component.

Parameters
anchor:AnchorPoint — A Target or Master AnchorPoint.
masterRemoved()method 
public override function masterRemoved(anchor:AnchorPoint):void

Removes this DiagramLink from its parent container after that its Master DiagramObject has been removed and updates master or target Anchor point.

Parameters
anchor:AnchorPoint — Master or Target AnchorPoint.
postProcessPoints()method 
protected function postProcessPoints():void

Called after this DiagramLink has been added to its parent layer

preProcessPoints()method 
protected function preProcessPoints():void

Adds a third point to the points array if it contains only two points. In this case the coordinates of the third point are equal to the coordinates of the second point. It is essential that any link has at least three points so that the object it links can be moved freely horizontaly and vertically.

showFeedBack()method 
public function showFeedBack():void

Shows feedback effect on link

simplifyGeometry()method 
protected function simplifyGeometry():void

Transforms the points array into an array of three points by keeping only the first and last points and adding a third one in the middle.

syncReferences()method 
public override function syncReferences():void
systemLibraryStylesChanged()method 
protected function systemLibraryStylesChanged(event:SVGAssetLibraryEvent):void

Marks the DiagramLink component so that its updateDisplayList() method gets called during a later screen update to render the new system library styles.

Parameters
event:SVGAssetLibraryEvent — An SVGAssetLibraryEvent event.
toXML()method 
public override function toXML():XML

Writes this DiagramLink into an XML object.

Returns
XML — An XML object representing this DiagramLink.
uiCompleted()method 
public override function uiCompleted():void

Finalizes modifications on this DiagramLink, transmitted by its DiagramLinkUI. This method is called when user interaction with the correspondant DiagramLinkUI is completed and resulting DiagramLink update must be applied.

unlink()method 
public override function unlink():void

Removes all link references (master and target anchor points) of this DiagramLink.

updateAnnotationScope()method 
public override function updateAnnotationScope():void
updateColumnScope()method 
public override function updateColumnScope(fitContent:Boolean = true):void

Updates Column Scope.

Parameters
fitContent:Boolean (default = true)
updateDisplayList()method 
protected override function updateDisplayList(w:Number, h:Number):void

Draws the DiagramLink 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.

Parameters
w:Number — Width of the component.
 
h:Number — Height of the component.
updateFromMasterAnchorPoint()method 
protected function updateFromMasterAnchorPoint(anchor:AnchorPoint):void

Changes the position of this DiagramLink component according to changes on the Target or Master AnchorPoint. This anchor point must be the source or target AnchorPoint of this DiagramLink in order to inflict updates on this DiagramLink component.

Parameters
anchor:AnchorPoint — A Target or Master AnchorPoint.
updateScope()method 
public override function updateScope():void

Detects changes in dependancy toward the container of this DiagramLink, due to user modificatiosn on the source and target DiagramObject components, and updates it. In fact, in cases where this DiagramLink is modified to link DiagramObject components embedded in different lanes of a panel (or mbedded in different panels of a panels container), this DiagramLink must be removed from its current container and placed in the LinksLayer of that panel (panels container). This is what we call change in the scope of this DiagramLink. When called, this method updates the scope of this DiagramLink using knowledge about source and target DiagramObjects (source.master and target.master).

updateStyle()method 
public override function updateStyle():void

Updates style properties of this DiagramLink.

updateUIClass()method 
protected function updateUIClass():void

Modifies the UI class (a DiagramLinkUI subclass) according to this DiagramLink's behaviour

updateUILayer()method 
public override function updateUILayer(sourcelayer:DiagramLayer, targetlayer:DiagramLayer):void

Inflicts changes in the source layer and target layer on the container (DiagramLane or DiagramPanel) of the DiagramLinkUI _ui controlling this DiagramLink.

Parameters
sourcelayer:DiagramLayer — Source layer containing the source DiagramObject of this DiagramLink.
 
targetlayer:DiagramLayer — Target layer containing the target DiagramObject of this DiagramLink.