com.kapit.diagram.layers.DiagramLane

	Property	Defined by
		annotationslayer : AnnotationsLayer [read-only] The Annotations Layer embedded in this DiagramLane (containing all DiagramAnnotation instances).	DiagramLane
		closeable : Boolean [read-only] Indicates whether this DiagramLane can be closed according to its dragging status and panel children number.	DiagramLane
		collapsable : Boolean [read-only] Indicates whether this DiagramLane can be collapsed according to its dragging status and panel children number.	DiagramLane
		collapsed : Boolean [read-only] Indicates whether this DiagramLane is currently collapsed .	DiagramLane
		dataobjectid : String Data object id of the layer.	DiagramLayer
		defaultheight : Number Default height of this DiagramLane	DiagramLane
		did : String Diagram Unique ID that defines the Unique reference of this layer in order to enable fast access to different layers (by simply providing the correspondant ID).	DiagramLayer
		dragging : Boolean [read-only] Indicates whether this Diagram Lane is currently being dragged.	DiagramLane
		expandable : Boolean [read-only] Indicates whether this DiagramLane can be expanded.	DiagramLane
		expandedheight : Number [read-only] The expanded height of this DiagramLane.	DiagramLane
		extents : Point [read-only] The maximum extents of this DiagramLane	DiagramLane
		globalhorizontalextent : Number	DiagramLane
		horizontalextent : Number [read-only] The maximum horizontal extent of this DiagramLane	DiagramLane
		lane : DiagramLane Parent Diagram Lane if it exists.	DiagramLayer
		lastlane : Boolean [read-only]	DiagramLane
		linkslayer : LinksLayer [read-only] The Link Layer embedded in this DiagramLane(containing all DiagramLink instances).	DiagramLane
		panel : DiagramPanel [read-only] The parent DiagramPanel instance of this DiagramLane.	DiagramLane
		spriteslayer : SpritesLayer [read-only] The Sprites Layer embedded in this DiagramLane (containing all DiagramSprite instances).	DiagramLane
		storedheight : Number [read-only] The stored DiagramLane Height (generally used when exapnding a collapsed DiagramLane).	DiagramLane
		title : String The Diagram Lane title that is displayed by the Diagram Lane Caption.	DiagramLane
		uilayer : UILayer [read-only] The UIs Layer embedded in this DiagramLane (containing DiagramObjectUI instances) .	DiagramLane
		verticalextent : Number [read-only] The maximum vertical extent of this DiagramLane	DiagramLane
		view : DiagramView The Diagram View Container.	DiagramLayer
		visiblecaption : Boolean Indicates whether this Diagram Lane Caption is visible.	DiagramLane

	Property	Defined by
		_alpha : uint Alpha percentage.	DiagramLane
		_annotationslayer : AnnotationsLayer Annotations layer belonging to this DiagramLane and containing all DiagramAnnotation instances.	DiagramLane
		_border : DiagramLaneBorder DiagramLaneBorder belonging to this DiagramLane.	DiagramLane
		_caption : DiagramLaneCaption = null DiagramLaneCaption belonging to this DiagramLane.	DiagramLane
		_color : uint Background Color.	DiagramLane
		_dragging : Boolean = false Drag status of this DiagramLane.	DiagramLane
		_expandedheight : Number = NaN Height to be considered at expanded status.	DiagramLane
		_expandedmargin : Number Margin to be considered at expanded status.	DiagramLane
		_linkslayer : LinksLayer Links layer belonging to this DiagramLane and containing all DiagramLink instances.	DiagramLane
		_spriteslayer : SpritesLayer Sprites layer belonging to this DiagramLane and containing all DiagramSprite instances.	DiagramLane
		_storedheight : Number = NaN Stored Height to be considered when expanding a collapsed Diagramlane.	DiagramLane
		_uilayer : UILayer UI layer belonging to this DiagramLane and containing all DiagramObjectUI instances.	DiagramLane
		_view : DiagramView = null Diagram View in which this Diagram Layer is embedded.	DiagramLayer

	Method	Defined by
		DiagramLane(view:DiagramView) Creates a new DiagramLane instance with the a adequate style properties and mouse listeners.	DiagramLane
		activateUI(a:Boolean):void Activates or deactivates this DiagramLayer.	DiagramLayer
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject (DiagramSprite, DiagramLink, DiagramAnnotation or DiagramObjectUI) instance to this DiagramLane instance.	DiagramLane
		addSibling():void Adds a new Diagram Lane to the parent DiagramPanel component and updates the parent panel size.	DiagramLane
		appendToSVGDocument(doc:SVGSVGElement):void Adds this Diagram Lane in an SVG description to an SVGSVGElement (SVG document).	DiagramLane
		applyToObjects(f:Function, args:Array = null, filter:Function = null, filterargs:Array = null):void Applies a given function (processing logic) to this DiagramLayer given function parameters and according to a filter function and its parameters if defined.	DiagramLayer
		checkTagName(xml:XML):Boolean Checks if an XML object tag name is equal to this DiagramLayer tagname.	DiagramLayer
		cleanup():void Cleans up listeners.	DiagramLane
		clear():void Removes Diagram Layer children (Diagram Object and Diagram Layer instances).	DiagramLayer
		close():void Removes Diagram Lane from its parent DiagramPanel component and resizes both.	DiagramLane
		collapse():void Collapses this DiagramLane (resizing it to a collapsed size).	DiagramLane
		countObjects(f:Function, args:Array = null):uint Counts the diagram Objects contained in this DiagramLayer according to a filter function and its arguments.	DiagramLayer
		countObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):int	DiagramLane
		doDrag(event:MouseEvent):void Performs dragging operation while mouse move.	DiagramLane
		dragStarted(event:MouseEvent):void Starts a dragging operation by transmitting the dragging process to all this DiagramLane children.	DiagramLane
		dragStopped(event:MouseEvent):void Stops a dragging operation by transmitting the drag stop information to all this DiagramLane children.	DiagramLane
		draw():void Draws this DiagramLane (Rectangle).	DiagramLane
		expand():void Expands this DiagramLane (resizing it to an expanded size).	DiagramLane
		fromXML(xml:XML):void Parses this DiagramLane (including the different layers) from an XML object.	DiagramLane
		getElementByDataObjectId(doid:String):IDiagramElement	DiagramLayer
		getElementById(id:String):IDiagramElement	DiagramLayer
		getElementsByClass(cl:Class):Array	DiagramLayer
		getObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):Array	DiagramLane
		getSelectedObjects():Array	DiagramLane
		getTagName():String Returns the diagram lane tag name ("lane").	DiagramLane
		hasObjects():Boolean	DiagramLane
		hitTest(pt:Point):Boolean Determines if a given point is contained in this DiagramLane.	DiagramLane
		libraryStylesChanged(event:SVGAssetLibraryEvent):void Redraws this DiagramLayer and its children (IDiagramElements) when library styles and assets change given a SVGAssetLibraryEvent.	DiagramLayer
		notifyElementsLoaded():void	DiagramLayer
		retrieveObject(cont:DisplayObjectContainer, f:Function, args:Array = null, reverse:Boolean = true):DiagramObject Searches and retrieves one DiagramObject embedded in a DisplayObjectContainer using a provided search function (contains the tests that designates the diagram object we search for) and its arguments and according to a search direction.	DiagramLayer
		retrieveObjects(cont:DisplayObjectContainer, f:Function, args:Array = null, reverse:Boolean = true):Array Searches and retrieves a set DiagramObject embedded in a DisplayObjectContainer using a provided search function (contains the tests that designates diagram objects we search for) and its arguments and according to a search direction.	DiagramLayer
		setActualSize(w:Number, h:Number):void Sizes this DiagramLane.	DiagramLane
		storeHeight():void Returns the stored DiagramLane Height (generally used when exapnding a collapsed DiagramLane).	DiagramLane
		styleChanged(prop:String):void Detects changes to style properties and handle the change accordingly.	DiagramLayer
		syncReferences():void inherited	DiagramLayer
		toXML():XML Writes this DiagramLane into an XML object.	DiagramLane
		updateGlobalLinksPlacement():void Updates the placement of the Diagram Links contained in this Diagram Layer.	DiagramLayer

	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.	DiagramLane
		clearChrome():void Removes the Chrome elements of this Diagram Lane.	DiagramLane
		createChildren():void Creates DiagramLane children.	DiagramLane
		createChrome():void Creates the Chrome elements of this Diagram Lane by defining the UI Layer, the DiagramLaneBorder, the DiagramLaneCaption and listeners.	DiagramLane
		createMask():Shape Creates a mask object used by the `createChrome()` to control the visualization of this DiagramLane Children.	DiagramLane
		endCloseEffectHandler(event:TweenEvent):void Removes this Diagram Lane from its parent Diagram Lane given a TweenEvent (generated by the `close` method).	DiagramLane
		measure():void Calculates the default size (width and height), and optionally the default minimum size, of the Diagram Lane.	DiagramLane
		mouseMoveHandler(event:MouseEvent):void Applies dragging operation while moving the cursor.	DiagramLane
		mouseUpHandler(event:MouseEvent):void Finalizes the dragging operation after a mouse up event, updates the diagram lane position, links and its panel container and removes all used listeners.	DiagramLane
		moveHandler(event:MoveEvent):void Updates global diagram links while moving the DiagramLane.	DiagramLane
		removeHandler(event:FlexEvent):void Removes all listeners given a FlexEvent.	DiagramLane
		resizeHandler(event:ResizeEvent):void Handles resizing events by updating global links placement.	DiagramLane
		updateDisplayList(w:Number, h:Number):void Draws this DiagramLane and/or sizes and positions its children.	DiagramLane

Property detail

_alpha

property

protected var _alpha:uint

Alpha percentage.

_annotationslayer

property

protected var _annotationslayer:AnnotationsLayer

Annotations layer belonging to this DiagramLane and containing all DiagramAnnotation instances.

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:DiagramLaneBorder

DiagramLaneBorder belonging to this DiagramLane.

_caption

property

protected var _caption:DiagramLaneCaption = null

DiagramLaneCaption belonging to this DiagramLane.

closeable

property

closeable:Boolean [read-only]

Indicates whether this DiagramLane can be closed according to its dragging status and panel children number.

Implementation
public function get closeable():Boolean

collapsable

property

collapsable:Boolean [read-only]

Indicates whether this DiagramLane can be collapsed according to its dragging status and panel children number.

Implementation
public function get collapsable():Boolean

collapsed

property

collapsed:Boolean [read-only]

Indicates whether this DiagramLane is currently collapsed .

Implementation
public function get collapsed():Boolean

_color

property

protected var _color:uint

Background Color.

defaultheight

property

defaultheight:Number [read-write]

Default height of this DiagramLane

Implementation
public function get defaultheight():Number
public function set defaultheight(value:Number):void

_dragging

property

protected var _dragging:Boolean = false

Drag status of this DiagramLane.

dragging

property

dragging:Boolean [read-only]

Indicates whether this Diagram Lane is currently being dragged.

Implementation
public function get dragging():Boolean

expandable

property

expandable:Boolean [read-only]

Indicates whether this DiagramLane can be expanded.

Implementation
public function get expandable():Boolean

_expandedheight

property

protected var _expandedheight:Number = NaN

Height to be considered at expanded status.

expandedheight

property

expandedheight:Number [read-only]

The expanded height of this DiagramLane.

Implementation
public function get expandedheight():Number

_expandedmargin

property

protected var _expandedmargin:Number

Margin to be considered at expanded status.

extents

property

extents:Point [read-only]

The maximum extents of this DiagramLane

Implementation
public function get extents():Point

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 DiagramLane

Implementation
public function get horizontalextent():Number

lastlane

property

lastlane:Boolean [read-only]

Implementation
public function get lastlane():Boolean

_linkslayer

property

protected var _linkslayer:LinksLayer

Links layer belonging to this DiagramLane and containing all DiagramLink instances.

linkslayer

property

linkslayer:LinksLayer [read-only]

The Link Layer embedded in this DiagramLane(containing all DiagramLink instances).

Implementation
public function get linkslayer():LinksLayer

panel

property

panel:DiagramPanel [read-only]

The parent DiagramPanel instance of this DiagramLane.

Implementation
public function get panel():DiagramPanel

_spriteslayer

property

protected var _spriteslayer:SpritesLayer

Sprites layer belonging to this DiagramLane and containing all DiagramSprite instances.

spriteslayer

property

spriteslayer:SpritesLayer [read-only]

The Sprites Layer embedded in this DiagramLane (containing all DiagramSprite instances).

Implementation
public function get spriteslayer():SpritesLayer

_storedheight

property

protected var _storedheight:Number = NaN

Stored Height to be considered when expanding a collapsed Diagramlane.

storedheight

property

storedheight:Number [read-only]

The stored DiagramLane Height (generally used when exapnding a collapsed DiagramLane).

Implementation
public function get storedheight():Number

title

property

title:String [read-write]

The Diagram Lane title that is displayed by the Diagram Lane Caption.

Implementation
public function get title():String
public function set title(value:String):void

_uilayer

property

protected var _uilayer:UILayer

UI layer belonging to this DiagramLane and containing all DiagramObjectUI instances.

uilayer

property

uilayer:UILayer [read-only]

The UIs Layer embedded in this DiagramLane (containing DiagramObjectUI instances) .

Implementation
public function get uilayer():UILayer

verticalextent

property

verticalextent:Number [read-only]

The maximum vertical extent of this DiagramLane

Implementation
public function get verticalextent():Number

visiblecaption

property

visiblecaption:Boolean [read-write]

Indicates whether this Diagram Lane Caption is visible.

Implementation
public function get visiblecaption():Boolean
public function set visiblecaption(value:Boolean):void

Constructor detail

DiagramLane

()

constructor

public function DiagramLane(view:DiagramView)

Creates a new DiagramLane instance with the a adequate style properties and mouse listeners.

Parameters

view:DiagramView — The DiagramView that contains this DiagramLane.

Method detail

addChild

()

method

public override function addChild(child:DisplayObject):DisplayObject

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

Parameters

child:DisplayObject — The DisplayObject (DiagramObject) instance to add as a child of this DiagramLane instance.

Returns

DisplayObject — The DisplayObject (DiagramObject) instance passed in the child parameter.

addSibling

()

method

public function addSibling():void

Adds a new Diagram Lane to the parent DiagramPanel component and updates the parent panel size.

appendToSVGDocument

()

method

public override function appendToSVGDocument(doc:SVGSVGElement):void

Adds this Diagram Lane in an SVG description to an SVGSVGElement (SVG document).

Parameters

doc:SVGSVGElement — SVGSVGElement (SVG document) to be updated by adding this DiagramLane.

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.

Parameters

event:MouseEvent — Detected Mouse Event.

cleanup

()

method

public override function cleanup():void

Cleans up listeners.

clearChrome

()

method

protected function clearChrome():void

Removes the Chrome elements of this Diagram Lane.

()

method

public function close():void

Removes Diagram Lane from its parent DiagramPanel component and resizes both.

collapse

()

method

public function collapse():void

Collapses this DiagramLane (resizing it to a collapsed size). The operation affects the Panel container size.

countObjectsByClass

()

method

public function countObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):int

Parameters

	`cl:Class` — retrieved elements inherit from cl

	`f:Function` (default = `null`) — a Boolean filter function to test retrieved elements against

	`fargs:Array` (default = `null`) — of the filter function

Returns

int — the number of objects matching the given class and filter function

createChildren

()

method

protected override function createChildren():void

Creates DiagramLane children. They are listed as follows:

Layers: Link, Sprites, Annotation layers
Chrome: UI Layer, DiagramLaneCaption (Title and Control Bar), DiagramLaneBorder(Lane border)

createChrome

()

method

protected function createChrome():void

Creates the Chrome elements of this Diagram Lane by defining the UI Layer, the DiagramLaneBorder, the DiagramLaneCaption and listeners.

createMask

()

method

protected function createMask():Shape

Creates a mask object used by the createChrome() to control the visualization of this DiagramLane Children.

Returns

Shape — Mask Shape.

doDrag

()

method

public function doDrag(event:MouseEvent):void

Performs dragging operation while mouse move.

Parameters

event:MouseEvent — Detected Mouse Event.

dragStarted

()

method

public function dragStarted(event:MouseEvent):void

Starts a dragging operation by transmitting the dragging process to all this DiagramLane children.

Parameters

event:MouseEvent — Detected Mouse Event.

dragStopped

()

method

public function dragStopped(event:MouseEvent):void

Stops a dragging operation by transmitting the drag stop information to all this DiagramLane children.

Parameters

event:MouseEvent — Detected Mouse Event.

draw

()

method

public override function draw():void

Draws this DiagramLane (Rectangle). The call of the invalidateDisplayList() method is aimed at executing the component's updateDisplayList() method at the next screen update.

endCloseEffectHandler

()

method

protected function endCloseEffectHandler(event:TweenEvent):void

Removes this Diagram Lane from its parent Diagram Lane given a TweenEvent (generated by the close method).

Parameters

event:TweenEvent — Detected Tween Event.

expand

()

method

public function expand():void

Expands this DiagramLane (resizing it to an expanded size). The operation affects the Panel container size.

fromXML

()

method

public override function fromXML(xml:XML):void

Parses this DiagramLane (including the different layers) from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramLane.

getObjectsByClass

()

method

public function getObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):Array

Parameters

	`cl:Class` — retrieved elements inherit from cl

	`f:Function` (default = `null`) — a Boolean filter function to test retrieved elements against

	`fargs:Array` (default = `null`) — parameters of the filter function

Returns

Array — an array of filtered elements whose class is a subclass of the given argument

getSelectedObjects

()

method

public override function getSelectedObjects():Array

Returns

Array — an array of selected objects

getTagName

()

method

public override function getTagName():String

Returns the diagram lane tag name ("lane").

Returns

String — Lane Tag Name.

hasObjects

()

method

public function hasObjects():Boolean

Returns

Boolean — true if this DiagramLane is not empty, false otherwise

hitTest

()

method

public function hitTest(pt:Point):Boolean

Determines if a given point is contained in this DiagramLane. This method is aimed at enabling user interaction as given a cursor hit point, we are able to know if this DiagramLane is concerned.

Parameters

pt:Point — Point to test.

Returns

Boolean — True if the hit point is contained in the DiagramLane.

measure

()

method

protected override function measure():void

Calculates the default size (width and height), and optionally the default minimum size, of the Diagram Lane.

mouseMoveHandler

()

method

protected function mouseMoveHandler(event:MouseEvent):void

Applies dragging operation while moving the cursor. The parent DiagramPanel component is updated according to the evolution of the dragging process.

Parameters

event:MouseEvent — Detected Mouse Event.

mouseUpHandler

()

method

protected function mouseUpHandler(event:MouseEvent):void

Finalizes the dragging operation after a mouse up event, updates the diagram lane position, links and its panel container and removes all used listeners.

Parameters

event:MouseEvent — Detected Mouse Event.

moveHandler

()

method

protected function moveHandler(event:MoveEvent):void

Updates global diagram links while moving the DiagramLane.

Parameters

event:MoveEvent — Detected Mouse Event (Move Event).

removeHandler

()

method

protected function removeHandler(event:FlexEvent):void

Removes all listeners given a FlexEvent.

Parameters

event:FlexEvent — Detected Flex Event.

resizeHandler

()

method

protected function resizeHandler(event:ResizeEvent):void

Handles resizing events by updating global links placement.

Parameters

event:ResizeEvent — Detected Resize Event.

setActualSize

()

method

public override function setActualSize(w:Number, h:Number):void

Sizes this DiagramLane. Unlike directly setting the width and height properties, calling the setActualSize() method does not set the explictWidth and explicitHeight properties, so a future layout calculation may result in the object returning to its previous size.

Parameters

	`w:Number` — New Size Width.

	`h:Number` — New Size Height.

storeHeight

()

method

public function storeHeight():void

Returns the stored DiagramLane Height (generally used when exapnding a collapsed DiagramLane).

toXML

()

method

public override function toXML():XML

Writes this DiagramLane into an XML object.

Returns

XML — An XML object representing this DiagramLane.

updateDisplayList

()

method

protected override function updateDisplayList(w:Number, h:Number):void

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

Parameters

	`w:Number` — Width of this DiagramLane, in pixels, in the component's coordinates, regardless of the value of the scaleX property of this DiagramLane.

	`h:Number` — Height of this DiagramLane, in pixels, in the component's coordinates, regardless of the value of the scaleY property of this DiagramLane.

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class DiagramLane	Properties \| Methods

Package	com.kapit.diagram.layers
Class	public class DiagramLane
Inheritance	DiagramLane DiagramLayer mx.core.UIComponent