| Package | com.kapit.diagram.layers |
| Class | public class DiagramPanel |
| Inheritance | DiagramPanel  mx.containers.VDividedBox |
| Implements | IDiagramElement, ISVGExportable |
| Property | Defined by | ||
|---|---|---|---|
| annotationslayer : AnnotationsLayer
[read-only]
The Annotations Layer embedded in this DiagramLane (containing all DiagramAnnotation instances).
| DiagramPanel | ||
| closeable : Boolean [read-only]
Indicates whether this DiagramPanel can be closed according to its dragging status and DiagramPanelsContainer children number.
| DiagramPanel | ||
| collapsable : Boolean [read-only]
Indicates whether this DiagramPanel can be collapsed according to its dragging status and DiagramPanelsContainer children number.
| DiagramPanel | ||
| collapsed : Boolean [read-only]
Indicates whether this DiagramPanel component is currently collapsed .
| DiagramPanel | ||
| container : DiagramPanelsContainer
[read-only]
Returns the parent DiagramPanelsContainer instance containing this DiagramPanel.
| DiagramPanel | ||
| dataobjectid : String | DiagramPanel | ||
| defaultheight : Number
Default height of this DiagramPanel
| DiagramPanel | ||
| did : String | DiagramPanel | ||
| dragging : Boolean [read-only]
Indicates whether this DiagramPanel component is currently being dragged.
| DiagramPanel | ||
| dragginglane : DiagramLane
The DiagramLane, contained in this DiagramPanel, that is currently being dragged.
| DiagramPanel | ||
| expandable : Boolean [read-only]
Indicates whether this DiagramPanel can be expanded according to its dragging status and DiagramPanelsContainer children number.
| DiagramPanel | ||
| expandedheight : Number [read-only]
The expanded height of this DiagramPanel.
| DiagramPanel | ||
| globalhorizontalextent : Number | DiagramPanel | ||
| horizontalextent : Number [read-only]
The maximum horizontal extent of this DiagramPanel
| DiagramPanel | ||
| lanewidth : Number [read-only]
The Lanes width.
| DiagramPanel | ||
| lastpanel : Boolean [read-only]
| DiagramPanel | ||
| linkslayer : LinksLayer
[read-only]
The Link Layer embedded in this DiagramLane(containing "lane to lane" DiagramLink instances).
| DiagramPanel | ||
| title : String
The DiagramPanel title that is displayed by the DiagramPanel Caption.
| DiagramPanel | ||
| verticalextent : Number [read-only]
The maximum vertical extent of this DiagramPanel
| DiagramPanel | ||
| view : DiagramView
[read-only]
The Diagram View Container.
| DiagramPanel | ||
| visiblecaption : Boolean
Indicates whether the DiagramPanelCaption of this DiagramPanel is currently visible.
| DiagramPanel | ||
| Property | Defined by | ||
|---|---|---|---|
| _border : DiagramLaneBorder
Used DiagramLaneBorder for DiagramLane children.
| DiagramPanel | ||
| _caption : DiagramPanelCaption = null
Used DiagramPanelCaption.
| DiagramPanel | ||
| _defaultheight : Number = 200
Default DiagramPanel height.
| DiagramPanel | ||
| _dragging : Boolean = false
Drag status of this DiagramPanel.
| DiagramPanel | ||
| _dragginglane : DiagramLane = null
The DiagramLane currently being dragged.
| DiagramPanel | ||
| _linksAnnotationLayer : AnnotationsLayer = null
Annotations layer belonging to this DiagramLane and containing all DiagramAnnotation instances.
| DiagramPanel | ||
| _linkslayer : LinksLayer = null
Links layer belonging to this DiagramPanel and containing "Lane to Lane" DiagramLink instances.
| DiagramPanel | ||
| _resizeeffect : Resize = null
Used resize effect for DiagramLane children.
| DiagramPanel | ||
| _totalheight : Number = 0
Actual Height of this DiagramPanel component(gaps are counted)
| DiagramPanel | ||
| _view : DiagramView = null
The Diagram View in which this DiagramPanel is embedded.
| DiagramPanel | ||
| Method | Defined by | ||
|---|---|---|---|
|
DiagramPanel(view:DiagramView)
Creates a new DiagramPanel instance with the a adequate style properties, effects and mouse listeners.
| DiagramPanel | ||
|
activateUI(a:Boolean):void
Activates or deactivates this DiagramPanel.
| DiagramPanel | ||
|
addChild(child:DisplayObject):DisplayObject
Adds a child DisplayObject (DiagramSprite, DiagramLink, DiagramAnnotation or DiagramObjectUI) instance to this DiagramLane instance.
| DiagramPanel | ||
|
addChildAt(child:DisplayObject, idx:int):DisplayObject
Adds a child DiagramLane instance to this DiagramPanel instance.
| DiagramPanel | ||
|
addSibling():void
Adds a new DiagramPanel to the parent DiagramPanelsContainer component and updates the parent DiagramPanelsContainer size.
| DiagramPanel | ||
|
appendToSVGDocument(doc:SVGSVGElement):void
Adds this DiagramPanel instance in an SVG description to an SVGSVGElement (SVG document).
| DiagramPanel | ||
|
applyToLanes(f:Function, args:Array):void
Applies a given function (processing logic) to DiagramLane children of this DiagramPanel.
| DiagramPanel | ||
|
applyToObjects(f:Function, args:Array = null, filter:Function = null, filterargs:Array = null):void
Applies a given function (processing logic) to this DiagramPanel given function parameters and according to a filter function and its parameters if defined.
| DiagramPanel | ||
|
checkTagName(xml:XML):Boolean
Checks if an XML description is adequate to this DiagramPanel instance by checking the tag name property.
| DiagramPanel | ||
|
clear():void
Removes Diagram Panel children (Diagram Layers including Diagram Lanes).
| DiagramPanel | ||
|
close():void
Removes DiagramPanel from its parent DiagramPanelsContainer component and resizes both.
| DiagramPanel | ||
|
collapse():void
Collapses this DiagramPanel (resizing it to a collapsed size).
| DiagramPanel | ||
|
countObjectsByClass(cl:Class, f:Function, fargs:Array):int
| DiagramPanel | ||
|
countSelectedObjects():uint
Counts all selected Diagram Objects inside this DiagramPanel.
| DiagramPanel | ||
|
deselectAll():void
Deselects all Diagram Objects inside this DiagramPanel.
| DiagramPanel | ||
|
doDrag(event:MouseEvent):void
Performs dragging operation while mouse move.
| DiagramPanel | ||
|
dragStarted(event:MouseEvent):void
Starts a dragging operation by transmitting the dragging process to all this DiagramPanel children.
| DiagramPanel | ||
|
dragStopped(event:MouseEvent):void
Stops a dragging operation by transmitting the drag stop information to all this DiagramLane children.
| DiagramPanel | ||
|
expand():void
Expands this DiagramPanel (resizing it to an expanded size).
| DiagramPanel | ||
|
fromXML(xml:XML):void
Parses this DiagramPanel from an XML object.
| DiagramPanel | ||
|
getDiagramLaneFromPoint(pt:Point, above:Boolean = true):DiagramLane
Returns the Diagram Lane, belonging to this DiagramPanel, from a given vertical point position
without considering the horizontal matching.
| DiagramPanel | ||
|
getDiagramLaneUnderPoint(pt:Point, rawmode:Boolean = true):DiagramLane
Returns the Diagram Lane, belonging to this DiagramPanel, under a given point.
| DiagramPanel | ||
|
getDiagramObjectUnderPoint(pt:Point, recursegroups:Boolean = false, selectableOnly:Boolean = false):DiagramObject
Returns the DiagramObject, belonging to this DiagramPanel, under a given point.
| DiagramPanel | ||
|
getElementByDataObjectId(doid:String):IDiagramElement
| DiagramPanel | ||
|
getElementById(id:String):IDiagramElement
| DiagramPanel | ||
|
getObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):Array
| DiagramPanel | ||
|
getSelectedObjects():Array
| DiagramPanel | ||
|
getTagName():String
Returns this DiagramPanel tag name ("panel").
| DiagramPanel | ||
|
hasObjects():Boolean
| DiagramPanel | ||
|
hitTest(pt:Point):Boolean
Determines if a given point is contained in this DiagramPanel.
| DiagramPanel | ||
|
libraryStylesChanged(event:SVGAssetLibraryEvent):void
Redraws this DiagramPanel and its children when library styles and assets change given a SVGAssetLibraryEvent.
| DiagramPanel | ||
|
notifyElementsLoaded():void
| DiagramPanel | ||
|
removeAll():void
Removes all selected Diagram Objects inside this DiagramPanel.
| DiagramPanel | ||
|
removeChild(child:DisplayObject):DisplayObject
Removes the specified child DiagramLane instance from the child list of this
DiagramPanel instance.
| DiagramPanel | ||
|
removeLane(idx:int):DiagramLane
Removes a DiagramLane at a specified index.
| DiagramPanel | ||
|
removeSelectedObjects():void
Removes all selected Diagram Objects inside this DiagramPanel.
| DiagramPanel | ||
|
resizeLane(lane:DiagramLane, heightfrom:Number, heightto:Number, endeffectlistener:Function = null, endresizeEffectHandler:Function = null):void
Resizes the a Diagram Lane while playing the resize effect.
| DiagramPanel | ||
|
selectAll():void
Selects all Diagram Objects inside this DiagramPanel.
| DiagramPanel | ||
|
selectObjectsInRect(grect:Rectangle, selectableOnly:Boolean):void
Selects all Diagram Objects of this DiagramPanel, contained insidea given Rectangle.
| DiagramPanel | ||
|
styleChanged(prop:String):void
Detects changes to style properties and handle the change accordingly.
| DiagramPanel | ||
|
syncReferences():void
| DiagramPanel | ||
|
toXML():XML
Writes this DiagramPanel into an XML object.
| DiagramPanel | ||
|
updateGlobalLinksPlacement():void
Updates the placement of the "lane to lane objects" Diagram Links contained in
the Link layer of this Diagram Panel.
| DiagramPanel | ||
| Method | Defined by | ||
|---|---|---|---|
|
captionMouseDownHandler(event:MouseEvent):void
Handles interaction with the Caption at mouse down by adding
mouseMoveHandler and
mouseUpHandler to the Diagram View Stage. | DiagramPanel | ||
|
clearChrome():void
Removes the Chrome elements of this Diagram Panel.
| DiagramPanel | ||
|
computeMeasuredHeight():Number
| DiagramPanel | ||
|
createChildren():void
Creates DiagramPanel children.
| DiagramPanel | ||
|
createChrome():void
Creates the Chrome elements of this DiagramPanel component by defining the DiagramLaneBorder, the DiagramPanelCaption
and listeners.
| DiagramPanel | ||
|
createMask():Shape
Creates a mask object used by the
createChrome() to control the visualization
of this DiagramPanel Children. | DiagramPanel | ||
|
dividerReleaseHandler(event:DividerEvent):void
Handles this DiagramPanel component resizing using the Vertical divider.
| DiagramPanel | ||
|
endCloseEffectHandler(event:TweenEvent):void
Removes this DiagramPanel from its parent DiagramPanelsContainer given a TweenEvent (generated by the
close method). | DiagramPanel | ||
|
endResizeEffectHandler(event:TweenEvent):void
Handles the end of the resizing effect by affecting updates on this DiagramPanel size
(calling the
invalidtaeSize() method). | DiagramPanel | ||
|
inihibitPercentSizes():void
Inhibit percent sizing as no Lane height limitation will be taken into consideration.
| DiagramPanel | ||
|
measure():void
Calculates the default size (width and height), and optionally the default minimum size, of the Diagram Panel.
| DiagramPanel | ||
|
mouseMoveHandler(event:MouseEvent):void
Applies dragging operation while moving the cursor.
| DiagramPanel | ||
|
mouseUpHandler(event:MouseEvent):void
Finalizes the dragging operation after a mouse up event, updates the DiagramPanel position, links
and its DiagramPanelsContainer and removes all used listeners.
| DiagramPanel | ||
|
moveHandler(event:MoveEvent):void
Updates global diagram links while moving the DiagramPanel component.
| DiagramPanel | ||
|
removeHandler(event:FlexEvent):void
Removes all listeners given a FlexEvent.
| DiagramPanel | ||
|
resizeHandler(event:ResizeEvent):void
Handles resizing events by updating global links placement.
| DiagramPanel | ||
|
updateCaptionsVisibility():void
Updates children Diagram Lane Captions visibility and style according
to the
view.multipanel property. | DiagramPanel | ||
|
updateDisplayList(w:Number, h:Number):void
Draws this DiagramPanel and/or sizes and positions its children.
| DiagramPanel | ||
| annotationslayer | property |
annotationslayer:AnnotationsLayer [read-only]The Annotations Layer embedded in this DiagramLane (containing all DiagramAnnotation instances).
Implementation public function get annotationslayer():AnnotationsLayer
| _border | property |
protected var _border:DiagramLaneBorderUsed DiagramLaneBorder for DiagramLane children.
| _caption | property |
protected var _caption:DiagramPanelCaption = nullUsed DiagramPanelCaption.
| closeable | property |
closeable:Boolean [read-only]Indicates whether this DiagramPanel can be closed according to its dragging status and DiagramPanelsContainer children number.
Implementation public function get closeable():Boolean
| collapsable | property |
collapsable:Boolean [read-only]Indicates whether this DiagramPanel can be collapsed according to its dragging status and DiagramPanelsContainer children number.
Implementation public function get collapsable():Boolean
| collapsed | property |
collapsed:Boolean [read-only]Indicates whether this DiagramPanel component is currently collapsed .
Implementation public function get collapsed():Boolean
| container | property |
container:DiagramPanelsContainer [read-only]Returns the parent DiagramPanelsContainer instance containing this DiagramPanel.
Implementation public function get container():DiagramPanelsContainer
| dataobjectid | property |
dataobjectid:String [read-write]Implementation
public function get dataobjectid():String
public function set dataobjectid(value:String):void
| _defaultheight | property |
protected var _defaultheight:Number = 200Default DiagramPanel height.
| defaultheight | property |
defaultheight:Number [read-write]Default height of this DiagramPanel
Implementation public function get defaultheight():Number
public function set defaultheight(value:Number):void
| did | property |
did:String [read-write]Implementation
public function get did():String
public function set did(value:String):void
| _dragging | property |
protected var _dragging:Boolean = falseDrag status of this DiagramPanel.
| dragging | property |
dragging:Boolean [read-only]Indicates whether this DiagramPanel component is currently being dragged.
Implementation public function get dragging():Boolean
| _dragginglane | property |
protected var _dragginglane:DiagramLane = nullThe DiagramLane currently being dragged.
| dragginglane | property |
dragginglane:DiagramLane [read-write]The DiagramLane, contained in this DiagramPanel, that is currently being dragged.
Implementation public function get dragginglane():DiagramLane
public function set dragginglane(value:DiagramLane):void
| expandable | property |
expandable:Boolean [read-only]Indicates whether this DiagramPanel can be expanded according to its dragging status and DiagramPanelsContainer children number.
Implementation public function get expandable():Boolean
| expandedheight | property |
expandedheight:Number [read-only]The expanded height of this DiagramPanel.
Implementation public function get expandedheight():Number
| globalhorizontalextent | property |
globalhorizontalextent:Number [read-write]Implementation
public function get globalhorizontalextent():Number
public function set globalhorizontalextent(value:Number):void
| horizontalextent | property |
horizontalextent:Number [read-only]The maximum horizontal extent of this DiagramPanel
Implementation public function get horizontalextent():Number
| lanewidth | property |
lanewidth:Number [read-only]The Lanes width.
Implementation public function get lanewidth():Number
| lastpanel | property |
lastpanel:Boolean [read-only]Implementation
public function get lastpanel():Boolean
| _linksAnnotationLayer | property |
protected var _linksAnnotationLayer:AnnotationsLayer = nullAnnotations layer belonging to this DiagramLane and containing all DiagramAnnotation instances.
| _linkslayer | property |
protected var _linkslayer:LinksLayer = nullLinks layer belonging to this DiagramPanel and containing "Lane to Lane" DiagramLink instances.
| linkslayer | property |
linkslayer:LinksLayer [read-only]The Link Layer embedded in this DiagramLane(containing "lane to lane" DiagramLink instances).
Implementation public function get linkslayer():LinksLayer
| _resizeeffect | property |
protected var _resizeeffect:Resize = nullUsed resize effect for DiagramLane children.
| title | property |
title:String [read-write]The DiagramPanel title that is displayed by the DiagramPanel Caption.
Implementation public function get title():String
public function set title(value:String):void
| _totalheight | property |
protected var _totalheight:Number = 0Actual Height of this DiagramPanel component(gaps are counted)
| verticalextent | property |
verticalextent:Number [read-only]The maximum vertical extent of this DiagramPanel
Implementation public function get verticalextent():Number
| _view | property |
protected var _view:DiagramView = nullThe Diagram View in which this DiagramPanel is embedded.
| view | property |
view:DiagramView [read-only]The Diagram View Container.
Implementation public function get view():DiagramView
| visiblecaption | property |
visiblecaption:Boolean [read-write]Indicates whether the DiagramPanelCaption of this DiagramPanel is currently visible.
Implementation public function get visiblecaption():Boolean
public function set visiblecaption(value:Boolean):void
| DiagramPanel | () | constructor |
public function DiagramPanel(view:DiagramView)Creates a new DiagramPanel instance with the a adequate style properties, effects and mouse listeners.
Parametersview:DiagramView — The DiagramView that contains this DiagramPanel.
|
| activateUI | () | method |
public function activateUI(a:Boolean):voidActivates or deactivates this DiagramPanel. An activated DiagramPanel component interacts with mouse events and a deactivated one doesn't.
Parametersa:Boolean — The desired value of the DiagramPanel active status.
|
| addChild | () | method |
public override function addChild(child:DisplayObject):DisplayObjectAdds a child DisplayObject (DiagramSprite, DiagramLink, DiagramAnnotation or DiagramObjectUI) instance to this DiagramLane instance. The child is added to the front (top) of all other children in this DiagramLane instance.
Parameterschild:DisplayObject — The DisplayObject (DiagramObject) instance to add as a child of this DiagramLane instance.
|
DisplayObject — The DisplayObject (DiagramObject) instance passed in the child parameter.
|
| addChildAt | () | method |
public override function addChildAt(child:DisplayObject, idx:int):DisplayObjectAdds a child DiagramLane instance to this DiagramPanel instance. The child is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DiagramPanel object.
Parameterschild:DisplayObject — The DiagramLane instance to add as a child of this DiagramLane instance.
|
|
idx:int — The index position to which the child is added.
If you specify a currently occupied index position, the child object that exists at that position and all higher positions are moved up one position in the child list.
|
DisplayObject — The DiagramLane instance that you pass in the child parameter.
|
| addSibling | () | method |
public function addSibling():voidAdds a new DiagramPanel to the parent DiagramPanelsContainer component and updates the parent DiagramPanelsContainer size.
| appendToSVGDocument | () | method |
public function appendToSVGDocument(doc:SVGSVGElement):voidAdds this DiagramPanel instance in an SVG description to an SVGSVGElement (SVG document).
Parametersdoc:SVGSVGElement — SVGSVGElement (SVG document) to be updated by adding this DiagramPanel.
|
| applyToLanes | () | method |
public function applyToLanes(f:Function, args:Array):voidApplies a given function (processing logic) to DiagramLane children of this DiagramPanel. given function parameters.
Parametersf:Function — Function to be applied on the DiagramLane children.
|
|
args:Array — Function arguments.
|
| applyToObjects | () | method |
public function applyToObjects(f:Function, args:Array = null, filter:Function = null, filterargs:Array = null):voidApplies a given function (processing logic) to this DiagramPanel given function parameters and according to a filter function and its parameters if defined. The application affects all this DiagramPanel children (that passes the filter constraints).
Parametersf:Function — Function to be applied on the DiagramPanel children.
|
|
args:Array (default = null) |
|
filter:Function (default = null) |
|
filterargs:Array (default = null) |
| captionMouseDownHandler | () | method |
protected function captionMouseDownHandler(event:MouseEvent):void
Handles interaction with the Caption at mouse down by adding mouseMoveHandler and
mouseUpHandler to the Diagram View Stage.
event:MouseEvent — Detected Mouse Event.
|
| checkTagName | () | method |
public function checkTagName(xml:XML):BooleanChecks if an XML description is adequate to this DiagramPanel instance by checking the tag name property.
Parametersxml:XML — Provided DiagramPanel Description
|
Boolean — Validity of the XML description (partial verification as it only checks the Tag Name).
|
| clear | () | method |
public function clear():voidRemoves Diagram Panel children (Diagram Layers including Diagram Lanes).
| clearChrome | () | method |
protected function clearChrome():voidRemoves the Chrome elements of this Diagram Panel.
| close | () | method |
public function close():voidRemoves DiagramPanel from its parent DiagramPanelsContainer component and resizes both.
| collapse | () | method |
public function collapse():voidCollapses this DiagramPanel (resizing it to a collapsed size). The operation affects the DiagramPanelsContainer size.
| computeMeasuredHeight | () | method |
protected function computeMeasuredHeight():Number
Returns
Number |
| countObjectsByClass | () | method |
public function countObjectsByClass(cl:Class, f:Function, fargs:Array):intParameters
cl:Class — retrieved elements inherit from cl
|
|
f:Function — a Boolean filter function to test retrieved elements against
|
|
fargs:Array — of the filter function
|
int — the number of objects matching the given class and filter function
|
| countSelectedObjects | () | method |
public function countSelectedObjects():uintCounts all selected Diagram Objects inside this DiagramPanel.
Returnsuint — Number of selected objects inside this DiagramPanel.
|
| createChildren | () | method |
protected override function createChildren():voidCreates DiagramPanel children. They are listed as follows:
| createChrome | () | method |
protected function createChrome():voidCreates the Chrome elements of this DiagramPanel component by defining the DiagramLaneBorder, the DiagramPanelCaption and listeners.
| createMask | () | method |
protected function createMask():Shape
Creates a mask object used by the createChrome() to control the visualization
of this DiagramPanel Children.
Shape — Mask Shape.
|
| deselectAll | () | method |
public function deselectAll():voidDeselects all Diagram Objects inside this DiagramPanel.
| dividerReleaseHandler | () | method |
protected function dividerReleaseHandler(event:DividerEvent):voidHandles this DiagramPanel component resizing using the Vertical divider.
Parametersevent:DividerEvent — Detected Divider Event.
|
| doDrag | () | method |
public function doDrag(event:MouseEvent):voidPerforms dragging operation while mouse move.
Parametersevent:MouseEvent — Detected Mouse Event.
|
| dragStarted | () | method |
public function dragStarted(event:MouseEvent):voidStarts a dragging operation by transmitting the dragging process to all this DiagramPanel children.
Parametersevent:MouseEvent — Detected Mouse Event.
|
| dragStopped | () | method |
public function dragStopped(event:MouseEvent):voidStops a dragging operation by transmitting the drag stop information to all this DiagramLane children.
Parametersevent:MouseEvent — Detected Mouse Event.
|
| endCloseEffectHandler | () | method |
protected function endCloseEffectHandler(event:TweenEvent):void
Removes this DiagramPanel from its parent DiagramPanelsContainer given a TweenEvent (generated by the close method).
event:TweenEvent — Detected Tween Event.
|
| endResizeEffectHandler | () | method |
protected function endResizeEffectHandler(event:TweenEvent):void
Handles the end of the resizing effect by affecting updates on this DiagramPanel size
(calling the invalidtaeSize() method).
event:TweenEvent — Detected Tween Event
|
| expand | () | method |
public function expand():voidExpands this DiagramPanel (resizing it to an expanded size). The operation affects the DiagramPanelsContainer size.
| fromXML | () | method |
public function fromXML(xml:XML):voidParses this DiagramPanel from an XML object.
Parametersxml:XML — An XML object represeting this DiagramPanel.
|
| getDiagramLaneFromPoint | () | method |
public function getDiagramLaneFromPoint(pt:Point, above:Boolean = true):DiagramLaneReturns the Diagram Lane, belonging to this DiagramPanel, from a given vertical point position without considering the horizontal matching. Just having a point that goes just above or just under a Diagram Lane top, the function returns that Diagram Lane. This is very usefull when dealing with dragging operations.
Parameterspt:Point — Point referring to a user selection inside this DiagramPanel component.
|
|
above:Boolean (default = true) |
DiagramLane —
The DiagramLane under the selection point.
|
| getDiagramLaneUnderPoint | () | method |
public function getDiagramLaneUnderPoint(pt:Point, rawmode:Boolean = true):DiagramLaneReturns the Diagram Lane, belonging to this DiagramPanel, under a given point. It is used to enable user interaction Diagram Lane selection inside a DiagramPanel component.
Parameterspt:Point — Point referring to a user selection inside this DiagramPanel component.
|
|
rawmode:Boolean (default = true) |
DiagramLane —
The DiagramLane under the selection point.
|
| getDiagramObjectUnderPoint | () | method |
public function getDiagramObjectUnderPoint(pt:Point, recursegroups:Boolean = false, selectableOnly:Boolean = false):DiagramObjectReturns the DiagramObject, belonging to this DiagramPanel, under a given point. It is used to enable Diagram Object selection inside a DiagramPanel component regardless of its Diagram Lane container.
Parameterspt:Point — Point referring to a user selection inside the DiagramPanel component.
|
|
recursegroups:Boolean (default = false) |
|
selectableOnly:Boolean (default = false) |
DiagramObject —
The DiagramObject under the selection point.
|
| getElementByDataObjectId | () | method |
public function getElementByDataObjectId(doid:String):IDiagramElementParameters
doid:String |
IDiagramElement |
| getElementById | () | method |
public function getElementById(id:String):IDiagramElementParameters
id:String |
IDiagramElement |
| getObjectsByClass | () | method |
public function getObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):ArrayParameters
cl:Class — retrieved elements inherit from cl
|
|
f:Function (default = null) |
|
fargs:Array (default = null) |
Array — an array of filtered elements whose class is a subclass of the given argument
|
| getSelectedObjects | () | method |
public function getSelectedObjects():Array
Returns
Array |
| getTagName | () | method |
public function getTagName():StringReturns this DiagramPanel tag name ("panel").
ReturnsString — Diagram Panel Tag Name.
|
| hasObjects | () | method |
public function hasObjects():Boolean
Returns
Boolean |
| hitTest | () | method |
public function hitTest(pt:Point):BooleanDetermines if a given point is contained in this DiagramPanel. This method is aimed at enabling user interaction as given a cursor hit point, we are able to know if this DiagramPanel is concerned.
Parameterspt:Point — Point to test.
|
Boolean — True if the hit point is contained in this DiagramPanel.
|
| inihibitPercentSizes | () | method |
protected function inihibitPercentSizes():voidInhibit percent sizing as no Lane height limitation will be taken into consideration.
| libraryStylesChanged | () | method |
public function libraryStylesChanged(event:SVGAssetLibraryEvent):voidRedraws this DiagramPanel and its children when library styles and assets change given a SVGAssetLibraryEvent.
Parametersevent:SVGAssetLibraryEvent — SVGAssetLibraryEvent telling a change in asset library properties.
|
| measure | () | method |
protected override function measure():voidCalculates the default size (width and height), and optionally the default minimum size, of the Diagram Panel.
| mouseMoveHandler | () | method |
protected function mouseMoveHandler(event:MouseEvent):voidApplies dragging operation while moving the cursor. The parent DiagramPanelsContainer component is updated according to the evolution of the dragging process.
Parametersevent:MouseEvent — Detected Mouse Event.
|
| mouseUpHandler | () | method |
protected function mouseUpHandler(event:MouseEvent):voidFinalizes the dragging operation after a mouse up event, updates the DiagramPanel position, links and its DiagramPanelsContainer and removes all used listeners.
Parametersevent:MouseEvent — Detected Mouse Event.
|
| moveHandler | () | method |
protected function moveHandler(event:MoveEvent):voidUpdates global diagram links while moving the DiagramPanel component.
Parametersevent:MoveEvent — Detected Mouse Event (Move Event).
|
| notifyElementsLoaded | () | method |
public function notifyElementsLoaded():void
| removeAll | () | method |
public function removeAll():voidRemoves all selected Diagram Objects inside this DiagramPanel.
| removeChild | () | method |
public override function removeChild(child:DisplayObject):DisplayObjectRemoves the specified child DiagramLane instance from the child list of this DiagramPanel instance. The parent property of the removed child is set to null , and the object is garbage collected if no other references to the child exist. The index positions of any display objects above the child in this DiagramPanel are decreased by 1. The DiagramPanel size will be updated after the remove operation.
Parameterschild:DisplayObject — The DiagramLane instance to remove.
|
DisplayObject — The removed DiagramLane
|
| removeHandler | () | method |
protected function removeHandler(event:FlexEvent):voidRemoves all listeners given a FlexEvent.
Parametersevent:FlexEvent — Detected Flex Event.
|
| removeLane | () | method |
public function removeLane(idx:int):DiagramLaneRemoves a DiagramLane at a specified index. This index refers to the Diagram Lane position in the children list of this DiagramPanel.
Parametersidx:int — Index of the Diagram Lane to be removed.
|
DiagramLane —
Removed DiagramLane.
|
| removeSelectedObjects | () | method |
public function removeSelectedObjects():voidRemoves all selected Diagram Objects inside this DiagramPanel.
| resizeHandler | () | method |
protected function resizeHandler(event:ResizeEvent):voidHandles resizing events by updating global links placement.
Parametersevent:ResizeEvent — Detected Resize Event.
|
| resizeLane | () | method |
public function resizeLane(lane:DiagramLane, heightfrom:Number, heightto:Number, endeffectlistener:Function = null, endresizeEffectHandler:Function = null):voidResizes the a Diagram Lane while playing the resize effect.
Parameterslane:DiagramLane — Diagram Lane to be resized.
|
|
heightfrom:Number — DiagramLane height from which the resize effect starts.
|
|
heightto:Number — DiagramLane height to which the DiagramLane will be resized
and at which the resize effect stops.
|
|
endeffectlistener:Function (default = null) |
|
endresizeEffectHandler:Function (default = null) |
| selectAll | () | method |
public function selectAll():voidSelects all Diagram Objects inside this DiagramPanel.
| selectObjectsInRect | () | method |
public function selectObjectsInRect(grect:Rectangle, selectableOnly:Boolean):voidSelects all Diagram Objects of this DiagramPanel, contained insidea given Rectangle. This function can be used for multiple selection.
Parametersgrect:Rectangle — Selection rectangle inside which all Diagram Objects will be selected.
|
|
selectableOnly:Boolean |
| styleChanged | () | method |
public override function styleChanged(prop:String):void
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.
prop:String — The name of the style property, or null if all styles for this DiagramPanel have changed.
|
| syncReferences | () | method |
public function syncReferences():void
| toXML | () | method |
public function toXML():XMLWrites this DiagramPanel into an XML object.
ReturnsXML — An XML object representing this DiagramPanel.
|
| updateCaptionsVisibility | () | method |
protected function updateCaptionsVisibility():void
Updates children Diagram Lane Captions visibility and style according
to the view.multipanel property. If the multipanel property
is activated, all children Diagram Lane Captions are set to Visible.
| updateDisplayList | () | method |
protected override function updateDisplayList(w:Number, h:Number):void
Draws this DiagramPanel and/or sizes and positions its children. This method is called when this DiagramPanel is added to
a container using the addChild method, and when the component's invalidateDisplayList method is called.
w:Number — Width of this DiagramPanel, in pixels, in the component's coordinates, regardless of the value of the scaleX property of this DiagramPanel.
|
|
h:Number — Height of this DiagramPanel, in pixels, in the component's coordinates, regardless of the value of the scaleY property of this DiagramPanel.
|
| updateGlobalLinksPlacement | () | method |
public function updateGlobalLinksPlacement():voidUpdates the placement of the "lane to lane objects" Diagram Links contained in the Link layer of this Diagram Panel.