com.kapit.diagram.view.DiagramGroup

Public Properties

	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 Indicates whether grouping is allowed for this DiagramObject.	DiagramObject
		allowinputlinks : Boolean Indicates whether input links are allowed for this DiagramObject.	DiagramObject
		allowoutputlinks : Boolean Indicates whether output links are allowed for this DiagramObject.	DiagramObject
		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
		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
		grouped : Boolean Indicates whether this DiagramObject belongs to a DiagramGroup.	DiagramObject
		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.	DiagramGroup
		innercenter : Point	DiagramObject
		innerheight : Number [read-only] The inner height of this DiagramGroup.	DiagramGroup
		innerleft : Number [read-only] The inner left position (X coordinate).	DiagramGroup
		innerright : Number	DiagramObject
		innertop : Number [read-only] The inner top position (Y coordinate).	DiagramGroup
		innerwidth : Number [read-only] The inner width of this DiagramGroup.	DiagramGroup
		innerxcenter : Number	DiagramObject
		innerycenter : Number	DiagramObject
		inputlinks : Array	DiagramObject
		lane : DiagramLane The DiagagramLane that contains thsi DiagramObject.	DiagramObject
		layer : DiagramLayer The DiagramLayer that contains this DiagramObject.	DiagramObject
		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
		resizeenabled : Boolean Tells if the diagram object is resize enabled.	DiagramObject
		scaleAsMaster : Boolean If true, the object scale as his master.	DiagramObject
		selectable : Boolean Tells if the diagram object is selectable.	DiagramObject
		selected : Boolean Indicates whether this DiagramObject is currently selected.	DiagramObject
		sprite : Sprite This DiagramObject casted as Sprite instance.	DiagramObject
		stayInsideMaster : Boolean If true, the object must stay inside his master innerbox.	DiagramObject
		toplevelgroup : DiagramGroup The top level DiagramGroup in which this DiagramObject is embedded.	DiagramObject
		transformUILocked : Boolean	DiagramObject
		ui : DiagramObjectUI The DiagramObjectUI controlling this DiagramObject.	DiagramObject
		ungrouped : Boolean	DiagramGroup
		view : DiagramView The DiagramView that contains this DiagramObject.	DiagramObject
		x : Number The absolute horizontal coordinate of this DiagramObject.	DiagramObject
		y : Number The absolute vertical coordinate of this DiagramObject.	DiagramObject

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	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
		_box : Rectangle = null Rectangle totally surrounding the grouped DiagramObject components.	DiagramGroup
		_columnAffiliation : DiagramColumn Diagram Column to which this DiagramObject belongs.	DiagramObject
		_compositeBounds : Array = null	DiagramObject
		_compositionBoundIndex : int = -1	DiagramObject
		_dragging : Boolean = false Indicates whether this DiagramObject is curretly being dragged.	DiagramObject
		_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
		_loading : Boolean = false Indicates whether the DiagramObject is currently loading.	DiagramObject
		_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
		_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
		_ungrouped : Boolean = false Flag indicating that the DiagramGroup has been ungrouped and is no longer existing.	DiagramGroup
		_view : DiagramView = null Diagram View to which this DiagramObject belongs.	DiagramObject
		_x : Number X coordinate of this DiagramObject.	DiagramObject
		_y : Number Y coordinate of this DiagramObject.	DiagramObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		DiagramGroup(view:DiagramView) Creates a new DiagramGroup.	DiagramGroup
		activateTransformUI(a:Boolean):void Activates or deactivates the Transform UI in Transform Mode.	DiagramObject
		activateUI(a:Boolean):void Activates or deactivates this DiagramGroup children.	DiagramGroup
		addChildAt(child:DisplayObject, idx:int):DisplayObject	DiagramObject
		addDiagramObject(dob:DiagramObject):void Adds a new DiagramObject to this DiagramGroup.	DiagramGroup
		anchorRemoved(anchor:AnchorPoint):void Removes an AnchorPoint from this DiagramObject AnchorPoints array.	DiagramObject
		appendToSVGDocument(doc:SVGSVGElement):void Adds this DiagramGroup object in SVG format to an SVGSVGElement object.	DiagramGroup
		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
		createAnchor(target:DiagramObject):AnchorPoint Creates a new AnchorPoint having this DiagramObject as master and `target` as target.	DiagramObject
		createAnnotation():DiagramAnnotation Creates a DiagramAnnotation	DiagramObject
		doDrag(event:MouseEvent):void Updates the position of the DiagramGroup after the dragging action is finished.	DiagramGroup
		dragStarted(event:MouseEvent):void Notifies all the children of this DiagramGroup that a dragging operation has been started.	DiagramGroup
		dragStopped(event:MouseEvent):void Notifies all the children of this DiagramGroup that the dragging operation has been stopped.	DiagramGroup
		fromXML(xml:XML):void Parses this DiagramGroup from an XML object.	DiagramGroup
		getExternalLinks(input:Boolean, root:DiagramGroup = null):Array Returns an Array of DiagramLinks whose source or target (depending on input parameter) is one of this group's children	DiagramGroup
		getLinkableSpriteIDs():Array Returns an array of available groups of linkable Sprite IDs.	DiagramObject
		getTagName():String Returns This DiagramGroup tagname equal to `"group"`.	DiagramGroup
		group(persist:Boolean):Boolean Groups all DiagramObject components to this DiagramGroup and updates the DiagramObjectUIs controlling these DiagramObject components and their position.	DiagramGroup
		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
		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
		intersectsRect(rect:Rectangle):Boolean Indicates whether the DiagramObject intersects with a given rectangle.	DiagramObject
		isInsideRect(rect:Rectangle):Boolean Indicates whether the DiagramObject is inside a given rectangle.	DiagramObject
		libraryStylesChanged(event:SVGAssetLibraryEvent):void Redraws this DiagramObject when library styles and assets change given a SVGAssetLibraryEvent and Marks it so that its `updateDisplayList()` method gets called during a later screen update..	DiagramObject
		linkCreated():void	DiagramObject
		masterAnchorPointUpdated(anchor:AnchorPoint):void Changes the position of this DiagramObject component after that its AnchorPoint has been updated.	DiagramObject
		masterRemoved(anchor:AnchorPoint):void Removes this AnchorPoint from its target object.	DiagramObject
		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 DiagramGroup(and all its children) so that its `innerbox` property fits the specified rectangle.	DiagramGroup
		setPosition(px:Number, py:Number, silent:Boolean = false):void Adjusts the location of the DiagramGroup, as determined by its top-left corner, to the specified position.	DiagramGroup
		syncReferences():void	DiagramGroup
		toXML():XML Writes this DiagramGroup into an XML object.	DiagramGroup
		uiCompleted():void Finalizes modifications on this DiagramGroup, transmitted by its DiagramGroupUI.	DiagramGroup
		ungroup():void Ungroups all DiagramObject components from this DiagramGroup and assigns to each ungrouped DiagramObject its right scope, position and links.	DiagramGroup
		ungrouping(group:DiagramGroup):void Inflicts removing this DiagramObject from a DiagramGroup, to the original and original group rectangles.	DiagramObject
		unlink():void Unlinks and removes all the DiagramObjects from this DiagramGroup by calling their `unlink()` methods.	DiagramGroup
		unregister():void	DiagramObject
		updateAnchorsPlacement(newbox:Rectangle = null, oldbox:Rectangle = null):void Updates the placement of all the anchors attached to this DiagramGroup and to its child DiagramObjects after it has been resized.	DiagramGroup
		updateAnnotationScope():void Updates the DiagramAnnotation attached to this DiagramObject after a change in its scope.	DiagramObject
		updateBox():void Forces this DiagramGroup to update its bounding box recursively calling this method on its children This method should be called after programmatic modifications of children placement	DiagramGroup
		updateColumnScope(fitContent:Boolean = true):void Updates Column Scope.	DiagramObject
		updateGlobalLinksPlacement():void Updates the placement of the DiagramLink objects linked to this DiagramObject.	DiagramObject
		updateLinksScope():void Updates links of the DiagramObject instances contained in this DiagramGroup according to its scope by applying the `updateScope()` method on each of its anchors.	DiagramGroup
		updateScope():void Updates this DiagramObject according to its new scope by updating : its layer container by calling the `view.objectLayerChanged()` method its scope dependancy by calling the `updateUILayer()` method its position its astyle its annotation position by calling the `updateAnnotationScope()` method The scope change concerns changes on: DiagramLayer of this DiagramLink DiagramLane, DiagramPanel and DiagramPanelsContainer containers of the DiagramLayer containing this DiagramLink As any DiagramObject is embedded in a DiagramLayer of a DiagramLane, a DiagramPanel or a DiagramPanelsContainer, any detected changes on the container of that DiagramLayer transmit changes to the scope of this DiagramObject	DiagramObject
		updateStyle():void Updates this DiagramObject style according to its scope (layer and dependancy to lane or panel).	DiagramObject
		updateUI():void Marks this DiagramObject so that its `updateDisplayList()` method gets called during a later screen update.	DiagramObject
		updateUILayer(sourcelayer:DiagramLayer, targetlayer:DiagramLayer):void Inflicts changes in the source layer and target layer on the container (DiagramLane or DiagramPanel) of the DiagramObjectUI `_ui` controlling this DiagramObject (must be a DiagramLink).	DiagramObject

	Method	Defined by
		applyTransform(matrix:Matrix, update:Boolean = true):void Applies the transformation matrix `matrix` to this DiagramObject component.	DiagramObject
		computeBox():Rectangle Determines the rectangle that contains this DiagramGroup by computing the union of the `innerbox` property of all its child DiagramObjects.	DiagramGroup
		createTransformUI():DiagramObjectUI Creates the TransformUI controlling this DiagramObject component.	DiagramObject
		createUI():DiagramObjectUI Creates the DiagramObjectUI controlling this DiagramObject component.	DiagramObject
		getLinks(input:Boolean):Array Returns DiagramLinks whose source or target is this object	DiagramObject
		updateDisplayList(w:Number, h:Number):void Draws the DiagramGroup and/or sizes and positions its children.	DiagramGroup

Property detail

_box

property

protected var _box:Rectangle = null

Rectangle totally surrounding the grouped DiagramObject components.

innerbox

property

innerbox:Rectangle [read-only]

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

Implementation
public function get innerbox():Rectangle

innerheight

property

innerheight:Number [read-only]

The inner height of this DiagramGroup.

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

Implementation
public function get innerwidth():Number

_ungrouped

property

protected var _ungrouped:Boolean = false

Flag indicating that the DiagramGroup has been ungrouped and is no longer existing.

ungrouped

property

ungrouped:Boolean  [read-write]Implementation
    public function get ungrouped():Boolean
    public function set ungrouped(value:Boolean):void

Constructor detail

DiagramGroup

()

constructor

public function DiagramGroup(view:DiagramView)

Creates a new DiagramGroup.

Parameters

view:DiagramView — The DiagramView that contains this DiagramGroup.

Method detail

activateUI

()

method

public override function activateUI(a:Boolean):void

Activates or deactivates this DiagramGroup children. An activated DiagramObject interacts with mouse events and a deactivated one doesn't.

Parameters

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

addDiagramObject

()

method

public function addDiagramObject(dob:DiagramObject):void

Adds a new DiagramObject to this DiagramGroup.

Parameters

dob:DiagramObject — The diagramObject to be added to the DiagramGroup.

appendToSVGDocument

()

method

public function appendToSVGDocument(doc:SVGSVGElement):void

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

Parameters

doc:SVGSVGElement — SVGSVGElement to be updated by adding this DiagramGroup object.

computeBox

()

method

protected function computeBox():Rectangle

Determines the rectangle that contains this DiagramGroup by computing the union of the innerbox property of all its child DiagramObjects.

Returns

Rectangle — The rectangle that contains this DiagramGroup.

doDrag

()

method

public override function doDrag(event:MouseEvent):void

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

Parameters

event:MouseEvent — A MouseEvent.

dragStarted

()

method

public override function dragStarted(event:MouseEvent):void

Notifies all the children of this DiagramGroup that a dragging operation has been started.

Parameters

event:MouseEvent — a MouseEvent.

dragStopped

()

method

public override function dragStopped(event:MouseEvent):void

Notifies all the children of this DiagramGroup that the dragging operation has been stopped.

Parameters

event:MouseEvent — A MouseEvent.

fromXML

()

method

public override function fromXML(xml:XML):void

Parses this DiagramGroup from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramGroup.

getExternalLinks

()

method

public function getExternalLinks(input:Boolean, root:DiagramGroup = null):Array

Returns an Array of DiagramLinks whose source or target (depending on input parameter) is one of this group's children

Parameters

	`input:Boolean` — if true searches DiagramLinks whose target is one of this group's children, source otherwise

	`root:DiagramGroup` (default = `null`) — the top level DiagramGroup, a null value (the default) means this DiagramGroup

Returns

Array — an array of DiagramLinks

getTagName

()

method

public override function getTagName():String

Returns This DiagramGroup tagname equal to "group".

Returns

String — This DiagramGroup tagname.

group

()

method

public function group(persist:Boolean):Boolean

Groups all DiagramObject components to this DiagramGroup and updates the DiagramObjectUIs controlling these DiagramObject components and their position.

Parameters

persist:Boolean

Returns

Boolean

setPlacement

()

method

public override function setPlacement(rect:Rectangle, update:Boolean = true):void

Changes the location and size of this DiagramGroup(and all its children) so that its innerbox property fits the specified rectangle.

Parameters

	`rect:Rectangle` — New value of the `innerbox` property.

	`update:Boolean` (default = `true`)

setPosition

()

method

public override function setPosition(px:Number, py:Number, silent:Boolean = false):void

Adjusts the location of the DiagramGroup, as determined by its top-left corner, to the specified position.

Parameters

	`px:Number` — New X coordinate of the top-left corner.

	`py:Number` — New Y coordinate of the top-left corner.

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

syncReferences

()

method

public override function syncReferences():void

toXML

()

method

public override function toXML():XML

Writes this DiagramGroup into an XML object.

Returns

XML — An XML object representing this DiagramGroup.

uiCompleted

()

method

public override function uiCompleted():void

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

ungroup

()

method

public function ungroup():void

Ungroups all DiagramObject components from this DiagramGroup and assigns to each ungrouped DiagramObject its right scope, position and links. The scope is linked to:

DiagramLayer of this DiagramLink
DiagramLane, DiagramPanel and DiagramPanelsContainer containers of the DiagramLayer containing this DiagramLink

unlink

()

method

public override function unlink():void

Unlinks and removes all the DiagramObjects from this DiagramGroup by calling their unlink() methods.

updateAnchorsPlacement

()

method

public override function updateAnchorsPlacement(newbox:Rectangle = null, oldbox:Rectangle = null):void

Updates the placement of all the anchors attached to this DiagramGroup and to its child DiagramObjects after it has been resized.

Parameters

	`newbox:Rectangle` (default = `null`) — new location of this DiagramGroup.

	`oldbox:Rectangle` (default = `null`) — old location of this DiagramGroup.

updateBox

()

method

public function updateBox():void

Forces this DiagramGroup to update its bounding box recursively calling this method on its children This method should be called after programmatic modifications of children placement

updateDisplayList

()

method

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

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

Parameters

	`w:Number` — Width of the component.

	`h:Number` — Height of the component.

updateLinksScope

()

method

public override function updateLinksScope():void

Updates links of the DiagramObject instances contained in this DiagramGroup according to its scope by applying the updateScope() method on each of its anchors. The scope change concerns changes on:

DiagramLayer of this DiagramLink
DiagramLane, DiagramPanel and DiagramPanelsContainer containers of the DiagramLayer containing this DiagramLink

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

Package	com.kapit.diagram.view
Class	public class DiagramGroup
Inheritance	DiagramGroup DiagramObject mx.core.UIComponent
Implements	ISVGExportable