| Package | com.kapit.diagram.view |
| Class | public class DiagramLink |
| Inheritance | DiagramLink DiagramObject mx.core.UIComponent |
| Implements | ISVGExportable |
| Property | Defined by | ||
|---|---|---|---|
![]() | allowannotation : Boolean
Indicates whether annotation is allowed for this DiagramObject.
| DiagramObject | |
![]() | allowcomposite : Boolean
Indicates whether this DiagramObject can be a composite (holding composition members).
| DiagramObject | |
![]() | allowcomposition : 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 | ||
![]() | allowinputlinks : Boolean
Indicates whether input links are allowed for this DiagramObject.
| DiagramObject | |
![]() | allowoutputlinks : 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 | ||
![]() | anchors : Array
An array containing the AnchorPoints of this DiagramObject.
| DiagramObject | |
![]() | annotation : DiagramAnnotation
DiagramAnnotation belonging to this DiagramObject.
| DiagramObject | |
![]() | canShowLinkBar : Boolean | DiagramObject | |
![]() | column : DiagramColumn
Diagram Column to which this DiagramObject belongs.
| DiagramObject | |
![]() | compositionBoundIndex : int
Position of object in composition.
| DiagramObject | |
![]() | compositionElements : int | DiagramObject | |
![]() | currentcolumn : DiagramColumn
The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .
| DiagramObject | |
![]() | currentscope : DiagramLane
The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .
| DiagramObject | |
| dashOffsets : Array
Dashed Array Offsets
| DiagramLink | ||
![]() | dataobjectid : String
Data object id of the diagram object.
| DiagramObject | |
![]() | did : String
The diagram unique identifier of this DiagramObject.
| DiagramObject | |
![]() | dragenabled : Boolean
Tells if the diagram object is drag enabled.
| DiagramObject | |
![]() | dragging : 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 | ||
![]() | innerbottom : 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 | ||
![]() | innercenter : Point | DiagramObject | |
| innerheight : Number [read-only]
The inner height of this DiagramLink.
| DiagramLink | ||
| innerleft : Number [read-only]
The inner left position (X coordinate).
| DiagramLink | ||
![]() | innerright : Number | DiagramObject | |
| innertop : Number [read-only]
The inner top position (Y coordinate).
| DiagramLink | ||
| innerwidth : Number [read-only]
The inner width of this DiagramLink.
| DiagramLink | ||
![]() | innerxcenter : Number | DiagramObject | |
![]() | innerycenter : Number | DiagramObject | |
![]() | inputlinks : Array | DiagramObject | |
![]() | lane : 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 | ||
![]() | loading : Boolean
Indicates whether the DiagramObject is currently loading.
| DiagramObject | |
![]() | master : AnchorPoint
Master AnchorPoint of this DiagramObject.
| DiagramObject | |
![]() | masterobject : DiagramObject
Master DiagramObject to which the master AnchorPoint depends.
| DiagramObject | |
![]() | moveInsideMaster : Boolean
If true, the object must move inside his master innerbox.
| DiagramObject | |
![]() | outputlinks : 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 | ||
![]() | resizeenabled : Boolean
Tells if the diagram object is resize enabled.
| DiagramObject | |
![]() | scaleAsMaster : Boolean
If true, the object scale as his master.
| DiagramObject | |
| scope : String [read-only]
| DiagramLink | ||
![]() | selectable : Boolean
Tells if the diagram object is selectable.
| DiagramObject | |
![]() | selected : 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 | ||
![]() | sprite : Sprite
This DiagramObject casted as Sprite instance.
| DiagramObject | |
![]() | stayInsideMaster : 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 | ||
![]() | toplevelgroup : DiagramGroup
The top level DiagramGroup in which this DiagramObject is embedded.
| DiagramObject | |
| toplevelsourceobject : DiagramObject
[read-only]
| DiagramLink | ||
| topleveltargetobject : DiagramObject
[read-only]
| DiagramLink | ||
![]() | transformUILocked : Boolean | DiagramObject | |
![]() | ui : DiagramObjectUI
The DiagramObjectUI controlling this DiagramObject.
| DiagramObject | |
![]() | view : 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 | ||
![]() | x : Number
The absolute horizontal coordinate of this DiagramObject.
| DiagramObject | |
![]() | y : Number
The absolute vertical coordinate of this DiagramObject.
| DiagramObject | |
| Property | Defined by | ||
|---|---|---|---|
![]() | _allowannotation : Boolean = true
Indicates whether annotation is supported by this DiagramObject.
| DiagramObject | |
![]() | _allowcomposite : Boolean = false
Indicates whether this DiagramObject can be a composite (result of a composition of objects).
| DiagramObject | |
![]() | _allowcomposition : Boolean = false
Indicates whether this DiagramObject can be a member of a composition.
| DiagramObject | |
![]() | _allowinputlinks : Boolean = true
Indicates whether input links are allowed for this DiagramObject.
| DiagramObject | |
![]() | _allowoutputlinks : Boolean = true
Indicates whether output links are allowed for this DiagramObject.
| DiagramObject | |
![]() | _anchors : Object = null
Array of DiagramLink linked to this DiagramObject
| DiagramObject | |
![]() | _annotation : DiagramAnnotation = null
Annotation attached to this DiagramObject.
| DiagramObject | |
![]() | __annotationid : String = "null"
Annotation ID of this DiagramObject where this DiagramObject is a DiagramAnnotation.
| DiagramObject | |
![]() | _columnAffiliation : DiagramColumn
Diagram Column to which this DiagramObject belongs.
| DiagramObject | |
![]() | _compositeBounds : Array = null | DiagramObject | |
![]() | _compositionBoundIndex : int = -1 | DiagramObject | |
| _dashoffsets : Array
Offsets for dash line drawing
| DiagramLink | ||
![]() | _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 | ||
![]() | _grouped : Boolean = false
Indicates whether this DiagramObject is a group.
| DiagramObject | |
![]() | _lastmatrix : Matrix = null
Last transformation matrix used to define the position and the size of this DiagramObject.
| DiagramObject | |
![]() | _layer : DiagramLayer = null
Layer in which this DiagramObject is embedded.
| DiagramObject | |
![]() | __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 | ||
![]() | _loading : Boolean = false
Indicates whether the DiagramObject is currently loading.
| DiagramObject | |
| _markersize : Number = 5
Size of a control point graphical marker.
| DiagramLink | ||
![]() | _master : AnchorPoint = null
Master anchor point of this DiagramObject used to anchor DiagramAnnotation and DiagramLink components.
| DiagramObject | |
![]() | __masterid : String = "null"
Master Anchor ID of this DiagramObject where this DiagramObject is a AnchorPoint.
| DiagramObject | |
![]() | _moveInsideMaster : Boolean = false
Indicates whether this DiagramObject move inside his master.
| DiagramObject | |
![]() | _ogrect : Rectangle = null
Original surrounding rectangle of the DiagramGroup to which this DiagramObject belongs.
| DiagramObject | |
![]() | _orect : Rectangle = null
Original surrounding rectangle of this DiagramObject.
| DiagramObject | |
![]() | _resizeenabled : Boolean = true
Indicates whether this DiagramObject is resizable.
| DiagramObject | |
![]() | __savedColumn : DiagramColumn = null | DiagramObject | |
![]() | __savedlayer : DiagramLayer = null
Layer to which this DiagramObject belongs to without considering user runtime modifications.
| DiagramObject | |
![]() | _selectable : Boolean = true
Indicates whether this DiagramObject is selectable.
| DiagramObject | |
![]() | _selected : Boolean = false
Indicates whether this DiagramObject is selected.
| DiagramObject | |
![]() | _selectedByMouseOver : Boolean = false
true if object was selected by mouse over
| DiagramObject | |
![]() | _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 | ||
![]() | _transformui : DiagramObjectUI = null
Transform UI that can be used only in transform mode.
| DiagramObject | |
![]() | _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 | |
![]() | _view : DiagramView = null
Diagram View to which this DiagramObject belongs.
| DiagramObject | |
![]() | _x : Number
X coordinate of this DiagramObject.
| DiagramObject | |
| _xgraphics : ExtendedGraphics
Extended graphics wrapper
| DiagramLink | ||
![]() | _y : Number
Y coordinate of this DiagramObject.
| DiagramObject | |
| Method | Defined by | ||
|---|---|---|---|
|
DiagramLink(view:DiagramView)
Creates a new DiagramLink instance.
| DiagramLink | ||
![]() |
activateTransformUI(a:Boolean):void
Activates or deactivates the Transform UI in Transform Mode.
| DiagramObject | |
![]() |
activateUI(a:Boolean):void
Activates or deactivates this DiagramObject.
| DiagramObject | |
![]() |
addChildAt(child:DisplayObject, idx:int):DisplayObject
| DiagramObject | |
![]() |
anchorRemoved(anchor:AnchorPoint):void
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 | ||
![]() |
checkTagName(xml:XML):Boolean
Checks if an XML object tag name is equal to this DiagramObject tag name.
| DiagramObject | |
![]() |
cleanup():void
Cleans up listeners.
| DiagramObject | |
![]() |
clearTransformUI():void
| DiagramObject | |
![]() |
clearUI():void
Hides UI elements (knobs, link bar, etc) until next screen update
| DiagramObject | |
![]() |
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 | ||
![]() |
dragStarted(event:MouseEvent):void
Notifies the start of a dragging operation of this DiagramObject.
| DiagramObject | |
![]() |
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 | ||
![]() |
getLinkableSpriteIDs():Array
Returns an array of available groups of linkable Sprite IDs.
| DiagramObject | |
|
getLinkPathInParentCoordinates():Array
| 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 | ||
![]() |
grouping(group:DiagramGroup):void
Inflicts adding this DiagramObject to a DiagramGroup, to the original and original group rectangles by
updating their values.
| DiagramObject | |
![]() |
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 | ||
![]() |
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 | |
![]() |
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 | ||
![]() |
isInsideRect(rect:Rectangle):Boolean
Indicates whether the DiagramObject is inside a given rectangle.
| DiagramObject | |
|
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. | DiagramLink | ||
![]() |
linkCreated():void
| DiagramObject | |
|
masterAnchorPointUpdated(anchor:AnchorPoint):void
Changes the position of this DiagramLink component according to
changes on the Target or Master AnchorPoint.
| DiagramLink | ||
|
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.
| DiagramLink | ||
![]() |
masterUpdated(anchor:AnchorPoint, scaleX:Number = 1, scaleY:Number = 1):void
| DiagramObject | |
![]() |
notifyScopeChanged():void
Detects and notifies changes in the scope of this DiagramObject.
| DiagramObject | |
![]() |
redispatchEvent(event:Event):void
Redispatches a received event to the DiagramObjectUI controlling this DiagramObject
_ui. | DiagramObject | |
![]() |
releaseActionBounds(index:int):void
| DiagramObject | |
![]() |
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 | |
![]() |
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 | ||
|
syncReferences():void
| DiagramLink | ||
|
toXML():XML
Writes this DiagramLink into an XML object.
| DiagramLink | ||
|
uiCompleted():void
Finalizes modifications on this DiagramLink, transmitted by its DiagramLinkUI.
| DiagramLink | ||
![]() |
ungrouping(group:DiagramGroup):void
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 | ||
![]() |
unregister():void
| DiagramObject | |
![]() |
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 | |
|
updateAnnotationScope():void
| DiagramLink | ||
|
updateColumnScope(fitContent:Boolean = true):void
Updates Column Scope.
| DiagramLink | ||
![]() |
updateGlobalLinksPlacement():void
Updates the placement of the DiagramLink objects linked to this DiagramObject.
| DiagramObject | |
![]() |
updateLinksScope():void
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 | ||
![]() |
updateUI():void
Marks this DiagramObject so that its
updateDisplayList()
method gets called during a later screen update. | DiagramObject | |
|
Inflicts changes in the source layer and target layer on the container (DiagramLane or DiagramPanel)
of the DiagramLinkUI
_ui controlling this DiagramLink. | DiagramLink | ||
| Method | Defined 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 | ||
![]() |
Creates the TransformUI controlling this DiagramObject component.
| DiagramObject | |
![]() |
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 | ||
![]() |
getLinks(input:Boolean):Array
Returns DiagramLinks whose source or target is this object
| DiagramObject | |
|
postProcessPoints():void
Called after this DiagramLink has been added to its parent layer
| DiagramLink | ||
|
preProcessPoints():void
Adds a third point to the
points array if it contains only two points. | DiagramLink | ||
|
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. | DiagramLink | ||
|
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. | DiagramLink | ||
|
updateDisplayList(w:Number, h:Number):void
Draws the DiagramLink and/or sizes and positions its children.
| DiagramLink | ||
|
updateFromMasterAnchorPoint(anchor:AnchorPoint):void
Changes the position of this DiagramLink component according to
changes on the Target or Master AnchorPoint.
| DiagramLink | ||
|
updateUIClass():void
Modifies the UI class (a DiagramLinkUI subclass) according to this DiagramLink's behaviour
| DiagramLink | ||
| allowgrouping | property |
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
| allowpointdelete | property |
allowpointdelete:Boolean [read-only]
Indicates whether it is permitted to delete points from the points array.
public function get allowpointdelete():Boolean
| allowpointinsert | property |
allowpointinsert:Boolean [read-only]
Indicates whether it is permitted to insert points to the points array.
public function get allowpointinsert():Boolean
| _dashoffsets | property |
protected var _dashoffsets:ArrayOffsets for dash line drawing
| dashOffsets | property |
dashOffsets:Array [read-write]Dashed Array Offsets
Implementation public function get dashOffsets():Array
public function set dashOffsets(value:Array):void
| _feedbackstyleselector | property |
protected var _feedbackstyleselector:String = ".feedback-link"CSS style selector (defined in the library), feedback mode
| feedbackstyleselector | property |
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
| grouped | property |
grouped:Boolean [write-only]Indicates whether this DiagramObject belongs to a DiagramGroup.
Implementation public function set grouped(value:Boolean):void
| innerbox | property |
innerbox:Rectangle [read-only]
The rectangle specified by the innerleft, innertop,
innerwidth and innerheight properties and obtained by calling the
computeBox() method.
public function get innerbox():Rectangle
| innerheight | property |
innerheight:Number [read-only]The inner height of this DiagramLink.
Implementation public function get innerheight():Number
| innerleft | property |
innerleft:Number [read-only]The inner left position (X coordinate).
Implementation public function get innerleft():Number
| innertop | property |
innertop:Number [read-only]The inner top position (Y coordinate).
Implementation public function get innertop():Number
| innerwidth | property |
innerwidth:Number [read-only]The inner width of this DiagramLink.
Implementation public function get innerwidth():Number
| lanescope | property |
lanescope:Boolean [read-only]Indicates whether the parent of the layer containing this DiagramLink is a DiagramLane.
Implementation public function get lanescope():Boolean
| LANESCOPE | property |
public static var LANESCOPE:String = "lane"
| layer | property |
layer:DiagramLayer [write-only]The DiagramLayer that contains this DiagramLink.
Implementation public function set layer(value:DiagramLayer):void
| _linecolor | property |
protected var _linecolor:NumberUsed line color for drawing this DiagramLink.
| lineColor | property |
lineColor:Number [read-write]Implementation
public function get lineColor():Number
public function set lineColor(value:Number):void
| _linecolordefault | property |
protected var _linecolordefault:NumberColor for the normal link behaviour
| _linecolorfeedback | property |
protected var _linecolorfeedback:NumberColor for the link in feedback mode
| _lineopacity | property |
protected var _lineopacity:NumberUsed line opacity for drawing this DiagramLink.
| lineOpacity | property |
lineOpacity:Number [read-write]Implementation
public function get lineOpacity():Number
public function set lineOpacity(value:Number):void
| _linewidth | property |
protected var _linewidth:NumberUsed line width for drawing this DiagramLink.
| lineWidth | property |
lineWidth:Number [read-write]Implementation
public function get lineWidth():Number
public function set lineWidth(value:Number):void
| _linktype | property |
protected var _linktype:DiagramLinkType = nullBehaviour, geometry, css style
| linktype | property |
linktype:DiagramLinkType [read-write]Implementation
public function get linktype():DiagramLinkType
public function set linktype(value:DiagramLinkType):void
| _markersize | property |
protected var _markersize:Number = 5Size of a control point graphical marker.
| panelscope | property |
panelscope:Boolean [read-only]Indicates whether the parent of the layer containing this DiagramLink is a DiagramPanel.
Implementation public function get panelscope():Boolean
| PANELSCOPE | property |
public static var PANELSCOPE:String = "panel"
| points | property |
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
| scope | property |
scope:String [read-only]Implementation
public function get scope():String
| source | property |
source:AnchorPoint [read-only]The AnchorPoint that attaches this DiagramLink to its master DiagramObject.
Implementation public function get source():AnchorPoint
| sourceobject | property |
sourceobject:DiagramObject [read-only]The master DiagramObject of this DiagramLink.
Implementation public function get sourceobject():DiagramObject
| _styleselector | property |
protected var _styleselector:String = ".lanescope-link"CSS style selector (defined in the library)
| styleselector | property |
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
| _target | property |
protected var _target:AnchorPoint = nullTarget anchor point linking to a target DiagramObject.
| target | property |
target:AnchorPoint [read-only]The AnchorPoint that attaches this DiagramLink to its target DiagramObject.
Implementation public function get target():AnchorPoint
| __targetid | property |
protected var __targetid:String = "null"ID of the Target AnchorPoint.
| targetobject | property |
targetobject:DiagramObject [read-only]The target DiagramObject of this DiagramLink.
Implementation public function get targetobject():DiagramObject
| toplevelsourceobject | property |
toplevelsourceobject:DiagramObject [read-only]Implementation
public function get toplevelsourceobject():DiagramObject
| topleveltargetobject | property |
topleveltargetobject:DiagramObject [read-only]Implementation
public function get topleveltargetobject():DiagramObject
| viewscope | property |
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
| VIEWSCOPE | property |
public static var VIEWSCOPE:String = "view"
| _xgraphics | property |
protected var _xgraphics:ExtendedGraphicsExtended graphics wrapper
| DiagramLink | () | constructor |
public function DiagramLink(view:DiagramView)Creates a new DiagramLink instance.
Parametersview:DiagramView — The DiagramView that contains this DiagramLink.
|
| appendToSVGDocument | () | method |
public function appendToSVGDocument(doc:SVGSVGElement):voidAdds this DiagramLink object in SVG format to an SVGSVGElement object.
Parametersdoc: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.
matrix:Matrix — A transformation matrix.
|
|
update:Boolean (default = true) |
| computeBox | () | method |
protected function computeBox(target:DisplayObject = null):RectangleDetermines the rectangle that contains this DiagramLink.
Parameterstarget:DisplayObject (default = null) |
Rectangle — The rectangle that contains this DiagramLink.
|
| createAnnotation | () | method |
| doDrag | () | method |
public override function doDrag(event:MouseEvent):voidUpdates the position of the DiagramLink after the dragging action is finished.
Parametersevent:MouseEvent — A MouseEvent.
|
| draw | () | method |
protected function draw():voidDraws 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):voidParses this DiagramLink from an XML object.
Parametersxml:XML — An XML object represeting this DiagramLink.
|
| getAnnotationLayer | () | method |
| getClosestSegmentIndexFromPoint | () | method |
public function getClosestSegmentIndexFromPoint(testpoint:Point):intParameters
testpoint:Point |
int |
| getIntersectionPointWithRectangle | () | method |
public function getIntersectionPointWithRectangle(rect:Rectangle):PointReturns intersection point (if any) of diagramlink with given rectangle
Parametersrect:Rectangle — Rectangle (global coordinates)
|
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
sprite:Sprite — Sprite considered as the clipping object.
|
|
pts:Array — Array of polyline control points.
|
|
global:Boolean |
Object — Object containing the following information:
|
| getTagName | () | method |
public override function getTagName():String
Returns This DiagramLink tagname equal to "link".
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
sprite:Sprite — Sprite considered as the clipping object.
|
|
pts:Array — Array of polyline control points.
|
Object — Object containing the following information:
|
| hideFeedBack | () | method |
public function hideFeedBack():voidHides 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):voidInitialises this DiagramLink instance with the required link parameters.
Parameterss: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):BooleanChecks if orthogonal diagramLink intersects with rectangle
Parametersrect:Rectangle |
Boolean — true 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.
event:SVGAssetLibraryEvent — An SVGAssetLibraryEvent event.
|
| masterAnchorPointUpdated | () | method |
public override function masterAnchorPointUpdated(anchor:AnchorPoint):voidChanges 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.
Parametersanchor:AnchorPoint — A Target or Master AnchorPoint.
|
| masterRemoved | () | method |
public override function masterRemoved(anchor:AnchorPoint):voidRemoves this DiagramLink from its parent container after that its Master DiagramObject has been removed and updates master or target Anchor point.
Parametersanchor:AnchorPoint — Master or Target AnchorPoint.
|
| postProcessPoints | () | method |
protected function postProcessPoints():voidCalled 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():voidShows 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.
event:SVGAssetLibraryEvent — An SVGAssetLibraryEvent event.
|
| toXML | () | method |
public override function toXML():XMLWrites this DiagramLink into an XML object.
ReturnsXML — An XML object representing this DiagramLink.
|
| uiCompleted | () | method |
public override function uiCompleted():voidFinalizes 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():voidRemoves 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):voidUpdates Column Scope.
ParametersfitContent: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.
w:Number — Width of the component.
|
|
h:Number — Height of the component.
|
| updateFromMasterAnchorPoint | () | method |
protected function updateFromMasterAnchorPoint(anchor:AnchorPoint):voidChanges 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.
Parametersanchor: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():voidUpdates style properties of this DiagramLink.
| updateUIClass | () | method |
protected function updateUIClass():voidModifies 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.
sourcelayer:DiagramLayer — Source layer containing the source DiagramObject of this DiagramLink.
|
|
targetlayer:DiagramLayer — Target layer containing the target DiagramObject of this DiagramLink.
|