com.kapit.diagram.layers.DiagramPanelsContainer

	Property	Defined by
		annotationslayer : AnnotationsLayer [read-only] The Annotations Layer embedded in this DiagramLane (containing all DiagramAnnotation instances).	DiagramPanelsContainer
		dataobjectid : String	DiagramPanelsContainer
		did : String	DiagramPanelsContainer
		draggingpanel : DiagramPanel The DiagramPanel, contained in this DiagramPanelContainer, that is currently being dragged.	DiagramPanelsContainer
		horizontalextent : Number [read-only] The maximum horizontal extent of this DiagramPanelsContainer	DiagramPanelsContainer
		linkslayer : LinksLayer [read-only] The Link Layer embedded in this DiagramLaneContainer component(containing "panel to panel" DiagramLink instances).	DiagramPanelsContainer
		verticalextent : Number [read-only] The maximum vertical extent of this DiagramPanelsContainer	DiagramPanelsContainer
		view : DiagramView [read-only] The Diagram View Container.	DiagramPanelsContainer

	Property	Defined by
		_draggingpanel : DiagramPanel = null The DiagramPanel currently being dragged.	DiagramPanelsContainer
		_linksAnnotationLayer : AnnotationsLayer = null Annotations layer belonging to this DiagramLane and containing all DiagramAnnotation instances.	DiagramPanelsContainer
		_linkslayer : LinksLayer = null Links layer belonging to this DiagramPanelsContainer and containing "Panel to Panel" DiagramLink instances.	DiagramPanelsContainer
		_resizeeffect : Resize = null Used resize effect for DiagramPanel children.	DiagramPanelsContainer
		_totalheight : Number = 0 Actual Height of this DiagramPanelsContainer component(gaps are counted)	DiagramPanelsContainer
		_view : DiagramView = null The Diagram View in which this DiagramPanelsContainer is embedded.	DiagramPanelsContainer

	Method	Defined by
		DiagramPanelsContainer(view:DiagramView) Creates a new DiagramPanelContainer instance with the a adequate style properties, effects and mouse listeners.	DiagramPanelsContainer
		activateUI(a:Boolean):void Activates or deactivates this DiagramPanelsContainer.	DiagramPanelsContainer
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject (DiagramSprite, DiagramLink, DiagramAnnotation or DiagramObjectUI) instance to this DiagramLane instance.	DiagramPanelsContainer
		addChildAt(child:DisplayObject, idx:int):DisplayObject Adds a child DiagramPanel component to this DiagramPanelsContainer component.	DiagramPanelsContainer
		appendToSVGDocument(doc:SVGSVGElement):void Adds this Diagram Panel Container in an SVG description to an SVGSVGElement (SVG document).	DiagramPanelsContainer
		applyToObjects(f:Function, args:Array = null, filter:Function = null, filterargs:Array = null):void Applies a given function (processing logic) to this DiagramPanelsContainer given function parameters and according to a filter function and its parameters if defined.	DiagramPanelsContainer
		applyToPanels(f:Function, args:Array):void Applies a given function (processing logic) to DiagramPanel children of this DiagramPanelsContainer.	DiagramPanelsContainer
		checkTagName(xml:XML):Boolean Checks if an XML description is adequate to this DiagramPanelContainer instance by checking the tag name property.	DiagramPanelsContainer
		clear():void Removes DiagramPanelsContainer children (Diagram Panels and Linkslayer).	DiagramPanelsContainer
		countObjectsByClass(cl:Class, f:Function, fargs:Array):int	DiagramPanelsContainer
		countSelectedObjects():uint Counts all selected Diagram Objects inside this DiagramPanelsContainer.	DiagramPanelsContainer
		deselectAll():void Deselects all Diagram Objects inside the DiagramPanelsContainer.	DiagramPanelsContainer
		fromXML(xml:XML):void Parses this DiagramPanelsContainer from an XML object.	DiagramPanelsContainer
		getDiagramLaneFromPoint(pt:Point, above:Boolean = true):DiagramLane Returns the DiagramLane instance, belonging to a DiagramPanel contained in this DiagramPanelsContainer , from a given vertical point position without considering the horizontal matching.	DiagramPanelsContainer
		getDiagramLaneUnderPoint(pt:Point, rawmode:Boolean = true):DiagramLane Returns the DiagramLane instance, belonging to one of the embedded DiagramPanel, under a given point.	DiagramPanelsContainer
		getDiagramObjectUnderPoint(pt:Point, recursegroups:Boolean = false, selectableOnly:Boolean = false):DiagramObject Returns the DiagramObject, belonging to this DiagramPanelContainer, under a given point.	DiagramPanelsContainer
		getDiagramPanelFromPoint(pt:Point, above:Boolean = true):DiagramPanel Returns the Diagram Panel, belonging to this DiagramPanelsContainer , from a given vertical point position without considering the horizontal matching.	DiagramPanelsContainer
		getElementByDataObjectId(doid:String):IDiagramElement	DiagramPanelsContainer
		getElementById(id:String):IDiagramElement	DiagramPanelsContainer
		getObjectsByClass(cl:Class, f:Function = null, fargs:Array = null):Array	DiagramPanelsContainer
		getSelectedObjects():Array	DiagramPanelsContainer
		getTagName():String Returns the diagramPanelsContainer tag name ("panels").	DiagramPanelsContainer
		hasObjects():Boolean	DiagramPanelsContainer
		libraryStylesChanged(event:SVGAssetLibraryEvent):void Redraws this DiagramPanelsContainer and its children when library styles and assets change given a SVGAssetLibraryEvent.	DiagramPanelsContainer
		notifyElementsLoaded():void	DiagramPanelsContainer
		removeAll():void Removes all selected Diagram Objects inside this DiagramPanelsContainer.	DiagramPanelsContainer
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DiagramPanel instance from the child list of this DiagramPanelContainer instance.	DiagramPanelsContainer
		removePanel(idx:int):DiagramPanel Removes a DiagramPanel at a specified index.	DiagramPanelsContainer
		removeSelectedObjects():void Removes all selected Diagram Objects inside this DiagramPanelsContainer.	DiagramPanelsContainer
		reset():void Resets default children of this DiagramPanelsContainer component after clearing all exisiting children.	DiagramPanelsContainer
		resizePanel(panel:DiagramPanel, heightfrom:Number, heightto:Number, endeffectlistener:Function = null):void Resizes the DiagramPanel component while playing the resize effect.	DiagramPanelsContainer
		scrollHandler(event:ScrollEvent):void Enables scrolling inside the DiagramPanelsContainer component (for viewing children Diagram Panels).	DiagramPanelsContainer
		selectAll():void Selects all Diagram Objects inside this DiagramPanelsContainer.	DiagramPanelsContainer
		selectObjectsInRect(grect:Rectangle, selectableOnly:Boolean = false):void Selects all Diagram Objects of this DiagramPanelContainer, contained inside a given Rectangle.	DiagramPanelsContainer
		styleChanged(prop:String):void Detects changes to style properties and handle the change accordingly.	DiagramPanelsContainer
		syncReferences():void	DiagramPanelsContainer
		toXML():XML Writes this DiagramPanelsContainer into an XML object.	DiagramPanelsContainer
		updateGlobalLinksPlacement():void Updates the placement of the "panel to panel" Diagram Links contained in the Link layer of this DiagramPanelContainer component.	DiagramPanelsContainer

	Method	Defined by
		computeMeasuredHeight():Number Computes the number that specifies the minimum height of the component, in pixels, in the DiagramPanelsContainer component's coordinates by taking into consideration the DiagramPanels'gaps.	DiagramPanelsContainer
		createChildren():void Creates DiagramPanelContainer component children.	DiagramPanelsContainer
		dividerReleaseHandler(event:DividerEvent):void Handles resizing using the Vertical divider.	DiagramPanelsContainer
		endResizeEffectHandler(event:TweenEvent):void Handles the end of the resizing effect by affecting updates on this DiagramPanelContainer and the parent DiagramView size (calling the `invalidtaeSize()` method).	DiagramPanelsContainer
		inhibitPercentSizes():void	DiagramPanelsContainer
		measure():void Calculates the default size (width and height), and optionally the default minimum size, of this DiagramPanelContainer component.	DiagramPanelsContainer
		removeHandler(event:FlexEvent):void Removes all listeners given a FlexEvent.	DiagramPanelsContainer
		updateCaptionsVisibility():void Updates children DiagramPanelCaption components visibility and style according to the `view.multipanel` property.	DiagramPanelsContainer
		updateDisplayList(w:Number, h:Number):void	DiagramPanelsContainer

Property detail

annotationslayer

property

annotationslayer:AnnotationsLayer [read-only]

The Annotations Layer embedded in this DiagramLane (containing all DiagramAnnotation instances).

Implementation
public function get annotationslayer():AnnotationsLayer

dataobjectid

property

dataobjectid:String  [read-write]Implementation
    public function get dataobjectid():String
    public function set dataobjectid(value:String):void

did

property

did:String  [read-write]Implementation
    public function get did():String
    public function set did(value:String):void

_draggingpanel

property

protected var _draggingpanel:DiagramPanel = null

The DiagramPanel currently being dragged.

draggingpanel

property

draggingpanel:DiagramPanel [read-write]

The DiagramPanel, contained in this DiagramPanelContainer, that is currently being dragged.

Implementation
public function get draggingpanel():DiagramPanel
public function set draggingpanel(value:DiagramPanel):void

horizontalextent

property

horizontalextent:Number [read-only]

The maximum horizontal extent of this DiagramPanelsContainer

Implementation
public function get horizontalextent():Number

_linksAnnotationLayer

property

protected var _linksAnnotationLayer:AnnotationsLayer = null

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

_linkslayer

property

protected var _linkslayer:LinksLayer = null

Links layer belonging to this DiagramPanelsContainer and containing "Panel to Panel" DiagramLink instances.

linkslayer

property

linkslayer:LinksLayer [read-only]

The Link Layer embedded in this DiagramLaneContainer component(containing "panel to panel" DiagramLink instances).

Implementation
public function get linkslayer():LinksLayer

_resizeeffect

property

protected var _resizeeffect:Resize = null

Used resize effect for DiagramPanel children.

_totalheight

property

protected var _totalheight:Number = 0

Actual Height of this DiagramPanelsContainer component(gaps are counted)

verticalextent

property

verticalextent:Number [read-only]

The maximum vertical extent of this DiagramPanelsContainer

Implementation
public function get verticalextent():Number

_view

property

protected var _view:DiagramView = null

The Diagram View in which this DiagramPanelsContainer is embedded.

view

property

view:DiagramView [read-only]

The Diagram View Container.

Implementation
public function get view():DiagramView

Constructor detail

DiagramPanelsContainer

()

constructor

public function DiagramPanelsContainer(view:DiagramView)

Creates a new DiagramPanelContainer instance with the a adequate style properties, effects and mouse listeners.

Parameters

view:DiagramView — The DiagramView that contains this DiagramPanelContainer.

Method detail

activateUI

()

method

public function activateUI(a:Boolean):void

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

Parameters

a:Boolean — The desired value of the DiagramPanelsContainer active status.

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.

addChildAt

()

method

public override function addChildAt(child:DisplayObject, idx:int):DisplayObject

Adds a child DiagramPanel component to this DiagramPanelsContainer component. The child is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DiagramPanelsContainer.

Parameters

	`child:DisplayObject` — The DiagramPanel 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.

Returns

DisplayObject — The DiagramPanel instance that you pass in the child parameter.

appendToSVGDocument

()

method

public function appendToSVGDocument(doc:SVGSVGElement):void

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

Parameters

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

applyToObjects

()

method

public function applyToObjects(f:Function, args:Array = null, filter:Function = null, filterargs:Array = null):void

Applies a given function (processing logic) to this DiagramPanelsContainer given function parameters and according to a filter function and its parameters if defined. The application affects all this DiagramPanelsContainer children (that passes the filter constraints).

Parameters

	`f:Function` — Function to be applied on this DiagramPanelsContainer children.

	`args:Array` (default = `null`) — Function arguments.

	`filter:Function` (default = `null`) — Filter function that selects the children that will be affected by the function.

	`filterargs:Array` (default = `null`) — Filter arguments.

applyToPanels

()

method

public function applyToPanels(f:Function, args:Array):void

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

Parameters

	`f:Function` — Function to be applied on the DiagramPanel children.

	`args:Array` — Function arguments.

checkTagName

()

method

public function checkTagName(xml:XML):Boolean

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

Parameters

xml:XML — Provided DiagramPanelContainer description

Returns

Boolean — Validity of the XML description (partial verification as it only checks the Tag Name).

clear

()

method

public function clear():void

Removes DiagramPanelsContainer children (Diagram Panels and Linkslayer).

computeMeasuredHeight

()

method

protected function computeMeasuredHeight():Number

Computes the number that specifies the minimum height of the component, in pixels, in the DiagramPanelsContainer component's coordinates by taking into consideration the DiagramPanels'gaps. The default value depends on the DiagramPanelContainer implementation.

Returns

Number — Computed measured height.

countObjectsByClass

()

method

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

Parameters

	`cl:Class` — retrieved elements inherit from cl

	`f:Function` — a Boolean filter function to test retrieved elements against

	`fargs:Array` — of the filter function

Returns

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

countSelectedObjects

()

method

public function countSelectedObjects():uint

Counts all selected Diagram Objects inside this DiagramPanelsContainer.

Returns

uint — Number of selected objects inside this DiagramPanelsContainer.

createChildren

()

method

protected override function createChildren():void

Creates DiagramPanelContainer component children. They are listed as follows:

Links layer ("panel to panel" Diagram Link)
DiagramPanel component
Listeners: remove and divide handlers.

deselectAll

()

method

public function deselectAll():void

Deselects all Diagram Objects inside the DiagramPanelsContainer.

dividerReleaseHandler

()

method

protected function dividerReleaseHandler(event:DividerEvent):void

Handles resizing using the Vertical divider.

Parameters

event:DividerEvent — Detected Divider Event.

endResizeEffectHandler

()

method

protected function endResizeEffectHandler(event:TweenEvent):void

Handles the end of the resizing effect by affecting updates on this DiagramPanelContainer and the parent DiagramView size (calling the invalidtaeSize() method).

Parameters

event:TweenEvent — Detected Tween Event

fromXML

()

method

public function fromXML(xml:XML):void

Parses this DiagramPanelsContainer from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramPanelsContainer.

getDiagramLaneFromPoint

()

method

public function getDiagramLaneFromPoint(pt:Point, above:Boolean = true):DiagramLane

Returns the DiagramLane instance, belonging to a DiagramPanel contained in this DiagramPanelsContainer , 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 it. This is very usefull when dealing with dragging operations.

Parameters

	`pt:Point` — Point referring to a user selection inside this DiagramPanelsContainer component.

	`above:Boolean` (default = `true`) — A boolean indicating whether the function should take into consideration the above or bottom lane selection.

Returns

DiagramLane — The DiagramLane under the selection point.

getDiagramLaneUnderPoint

()

method

public function getDiagramLaneUnderPoint(pt:Point, rawmode:Boolean = true):DiagramLane

Returns the DiagramLane instance, belonging to one of the embedded DiagramPanel, under a given point. It is used to enable Diagram Lane selection inside this DiagramPanelsContainer.

Parameters

	`pt:Point` — Point referring to a user selection inside the DiagramPanelsContainer component.

	`rawmode:Boolean` (default = `true`) — A boolean indicating whether the function should take into consideration any dragging operation.

Returns

DiagramLane — The DiagramLane under the selection point.

getDiagramObjectUnderPoint

()

method

public function getDiagramObjectUnderPoint(pt:Point, recursegroups:Boolean = false, selectableOnly:Boolean = false):DiagramObject

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

Parameters

	`pt:Point` — Point referring to a user selection inside this Diagram Panels Container.

	`recursegroups:Boolean` (default = `false`) — A boolean indicating whether the function should consider Diagram Group instances.

	`selectableOnly:Boolean` (default = `false`)

Returns

DiagramObject — The DiagramObject under the selection point.

getDiagramPanelFromPoint

()

method

public function getDiagramPanelFromPoint(pt:Point, above:Boolean = true):DiagramPanel

Returns the Diagram Panel, belonging to this DiagramPanelsContainer , from a given vertical point position without considering the horizontal matching. Just having a point that goes just above or just under a Diagram Panel top, the function returns that Diagram Panel. This is very usefull when dealing with dragging operations.

Parameters

	`pt:Point` — Point referring to a user selection inside the Diagram Panel.

	`above:Boolean` (default = `true`) — A boolean indicating whether the function should take into consideration the above or bottom lane selection.

Returns

DiagramPanel — The DiagramLane under the selection point.

getElementByDataObjectId

()

method

public function getElementByDataObjectId(doid:String):IDiagramElementParameters

doid:String

Returns

IDiagramElement

getElementById

()

method

public function getElementById(id:String):IDiagramElementParameters

id:String

Returns

IDiagramElement

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 function getSelectedObjects():Array

Returns

Array

getTagName

()

method

public function getTagName():String

Returns the diagramPanelsContainer tag name ("panels").

Returns

String — DiagramPanelsContainer Tag Name.

hasObjects

()

method

public function hasObjects():Boolean

Returns

Boolean

inhibitPercentSizes

()

method

protected function inhibitPercentSizes():void

libraryStylesChanged

()

method

public function libraryStylesChanged(event:SVGAssetLibraryEvent):void

Redraws this DiagramPanelsContainer and its children when library styles and assets change given a SVGAssetLibraryEvent.

Parameters

event:SVGAssetLibraryEvent — SVGAssetLibraryEvent telling a change in asset library properties.

measure

()

method

protected override function measure():void

Calculates the default size (width and height), and optionally the default minimum size, of this DiagramPanelContainer component.

notifyElementsLoaded

()

method

public function notifyElementsLoaded():void

removeAll

()

method

public function removeAll():void

Removes all selected Diagram Objects inside this DiagramPanelsContainer.

removeChild

()

method

public override function removeChild(child:DisplayObject):DisplayObject

Removes the specified child DiagramPanel instance from the child list of this DiagramPanelContainer 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 DiagramPanelContainer are decreased by 1. This DiagramPanelContainer size will be updated after the remove operation.

Parameters

child:DisplayObject — The DiagramPanel instance to remove.

Returns

DisplayObject — The removed DiagramPanel.

removeHandler

()

method

protected function removeHandler(event:FlexEvent):void

Removes all listeners given a FlexEvent.

Parameters

event:FlexEvent — Detected Flex Event.

removePanel

()

method

public function removePanel(idx:int):DiagramPanel

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

Parameters

idx:int — Index of the DiagramPanel to be removed.

Returns

DiagramPanel — Removed DiagramPanel.

removeSelectedObjects

()

method

public function removeSelectedObjects():void

Removes all selected Diagram Objects inside this DiagramPanelsContainer.

reset

()

method

public function reset():void

Resets default children of this DiagramPanelsContainer component after clearing all exisiting children.

resizePanel

()

method

public function resizePanel(panel:DiagramPanel, heightfrom:Number, heightto:Number, endeffectlistener:Function = null):void

Resizes the DiagramPanel component while playing the resize effect.

Parameters

	`panel:DiagramPanel` — DiagramPanel component to be resized.

	`heightfrom:Number` — DiagramPanel height from which the resize effect starts.

	`heightto:Number` — DiagramPanel component height to which the DiagramPanel component will be resized and at which the resize effect stops.

	`endeffectlistener:Function` (default = `null`) — Custom Listener to detect the end of the resize effect.

scrollHandler

()

method

public function scrollHandler(event:ScrollEvent):void

Enables scrolling inside the DiagramPanelsContainer component (for viewing children Diagram Panels).

Parameters

event:ScrollEvent — Detected Scroll Event.

selectAll

()

method

public function selectAll():void

Selects all Diagram Objects inside this DiagramPanelsContainer.

selectObjectsInRect

()

method

public function selectObjectsInRect(grect:Rectangle, selectableOnly:Boolean = false):void

Selects all Diagram Objects of this DiagramPanelContainer, contained inside a given Rectangle. This function can be used for multiple selection.

Parameters

	`grect:Rectangle` — Selection rectangle inside which all Diagram Objects will be selected.

	`selectableOnly:Boolean` (default = `false`)

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.

Parameters

prop:String — The name of the style property, or null if all styles for this DiagramPanelsContainer have changed.

syncReferences

()

method

public function syncReferences():void

toXML

()

method

public function toXML():XML

Writes this DiagramPanelsContainer into an XML object.

Returns

XML — An XML object representing this DiagramPanelsContainer.

updateCaptionsVisibility

()

method

protected function updateCaptionsVisibility():void

Updates children DiagramPanelCaption components visibility and style according to the view.multipanel property. If the multipanel property is activated, all children DiagramPanelCaption components are set to Visible.

updateDisplayList

()

method

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

	`w:Number`

	`h:Number`

updateGlobalLinksPlacement

()

method

public function updateGlobalLinksPlacement():void

Updates the placement of the "panel to panel" Diagram Links contained in the Link layer of this DiagramPanelContainer component.

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

Package	com.kapit.diagram.layers
Class	public class DiagramPanelsContainer
Inheritance	DiagramPanelsContainer mx.containers.VDividedBox
Implements	IDiagramElement, ISVGExportable