com.kapit.diagram.view.DiagramObject

	Property	Defined by
		allowannotation : Boolean [read-only] Indicates whether annotation is allowed for this DiagramObject.	DiagramObject
		allowcomposite : Boolean [read-only] Indicates whether this DiagramObject can be a composite (holding composition members).	DiagramObject
		allowcomposition : Boolean [read-only] Indicates whether this DiagramObject can be part of a composition.	DiagramObject
		allowgrouping : Boolean [read-only] Indicates whether grouping is allowed for this DiagramObject.	DiagramObject
		allowinputlinks : Boolean [read-only] Indicates whether input links are allowed for this DiagramObject.	DiagramObject
		allowoutputlinks : Boolean [read-only] Indicates whether output links are allowed for this DiagramObject.	DiagramObject
		anchors : Array [read-only] An array containing the AnchorPoints of this DiagramObject.	DiagramObject
		annotation : DiagramAnnotation [read-only] DiagramAnnotation belonging to this DiagramObject.	DiagramObject
		canShowLinkBar : Boolean [read-only]	DiagramObject
		column : DiagramColumn Diagram Column to which this DiagramObject belongs.	DiagramObject
		compositionBoundIndex : int [read-only] Position of object in composition.	DiagramObject
		compositionElements : int [read-only]	DiagramObject
		currentcolumn : DiagramColumn [read-only] The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .	DiagramObject
		currentscope : DiagramLane [read-only] 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 [read-only] 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 [read-only]	DiagramObject
		innerbox : Rectangle [read-only] The rectangle specified by the `innerleft`, `innertop`, `innerwidth` and `innerheight` properties.	DiagramObject
		innercenter : Point [read-only]	DiagramObject
		innerheight : Number [read-only] The inner height of this DiagramObject.	DiagramObject
		innerleft : Number [read-only] The inner left position (X coordinate).	DiagramObject
		innerright : Number [read-only]	DiagramObject
		innertop : Number [read-only] The inner top position (Y coordinate).	DiagramObject
		innerwidth : Number [read-only] The inner width of this DiagramObject.	DiagramObject
		innerxcenter : Number [read-only]	DiagramObject
		innerycenter : Number [read-only]	DiagramObject
		inputlinks : Array [read-only]	DiagramObject
		lane : DiagramLane [read-only] The DiagagramLane that contains thsi DiagramObject.	DiagramObject
		layer : DiagramLayer The DiagramLayer that contains this DiagramObject.	DiagramObject
		loading : Boolean [read-only] Indicates whether the DiagramObject is currently loading.	DiagramObject
		master : AnchorPoint [read-only] Master AnchorPoint of this DiagramObject.	DiagramObject
		masterobject : DiagramObject [read-only] Master DiagramObject to which the master AnchorPoint depends.	DiagramObject
		moveInsideMaster : Boolean If true, the object must move inside his master innerbox.	DiagramObject
		outputlinks : Array [read-only]	DiagramObject
		resizeenabled : Boolean Tells if the diagram object is resize enabled.	DiagramObject
		scaleAsMaster : Boolean [read-only] 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 [read-only] This DiagramObject casted as Sprite instance.	DiagramObject
		stayInsideMaster : Boolean If true, the object must stay inside his master innerbox.	DiagramObject
		toplevelgroup : DiagramGroup [read-only] The top level DiagramGroup in which this DiagramObject is embedded.	DiagramObject
		transformUILocked : Boolean [read-only]	DiagramObject
		ui : DiagramObjectUI [read-only] The DiagramObjectUI controlling this DiagramObject.	DiagramObject
		view : DiagramView [read-only] 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

	Property	Defined by
		_allowannotation : Boolean = true Indicates whether annotation is supported by this DiagramObject.	DiagramObject
		_allowcomposite : Boolean = false Indicates whether this DiagramObject can be a composite (result of a composition of objects).	DiagramObject
		_allowcomposition : Boolean = false Indicates whether this DiagramObject can be a member of a composition.	DiagramObject
		_allowinputlinks : Boolean = true Indicates whether input links are allowed for this DiagramObject.	DiagramObject
		_allowoutputlinks : Boolean = true Indicates whether output links are allowed for this DiagramObject.	DiagramObject
		_anchors : Object = null Array of DiagramLink linked to this DiagramObject	DiagramObject
		_annotation : DiagramAnnotation = null Annotation attached to this DiagramObject.	DiagramObject
		__annotationid : String = "null" Annotation ID of this DiagramObject where this DiagramObject is a DiagramAnnotation.	DiagramObject
		_columnAffiliation : DiagramColumn Diagram Column to which this DiagramObject belongs.	DiagramObject
		_compositeBounds : Array = null	DiagramObject
		_compositionBoundIndex : int = -1	DiagramObject
		_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
		_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

	Method	Defined by
		DiagramObject(view:DiagramView) Creates a new DiagramObject instance.	DiagramObject
		activateTransformUI(a:Boolean):void Activates or deactivates the Transform UI in Transform Mode.	DiagramObject
		activateUI(a:Boolean):void Activates or deactivates this DiagramObject.	DiagramObject
		addChildAt(child:DisplayObject, idx:int):DisplayObject	DiagramObject
		anchorRemoved(anchor:AnchorPoint):void Removes an AnchorPoint from this DiagramObject AnchorPoints array.	DiagramObject
		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 DiagramObject after the dragging action is finished.	DiagramObject
		dragStarted(event:MouseEvent):void Notifies the start of a dragging operation of this DiagramObject.	DiagramObject
		dragStopped(event:MouseEvent):void Notifies that the dragging operation of this DiagramObject is stopped and inflicts results to it.	DiagramObject
		fromXML(xml:XML):void Parses this DiagramObject from an XML object.	DiagramObject
		getLinkableSpriteIDs():Array Returns an array of available groups of linkable Sprite IDs.	DiagramObject
		getTagName():String Returns This DiagramObject tagname.	DiagramObject
		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 DiagramObject so that its `innerbox` property fits the specified rectangle.	DiagramObject
		setPosition(px:Number, py:Number, silent:Boolean = false):void Adjusts the location of the DiagramObject, as determined by its top-left corner, to the specified position and calls the `updateAnchorsPlacement()` and `updateScope()` methods.	DiagramObject
		syncReferences():void	DiagramObject
		toXML():XML Writes this DiagramObject into an XML object.	DiagramObject
		uiCompleted():void Finalizes modifications on this DiagramObject, transmitted by its DiagramObjectUI.	DiagramObject
		ungrouping(group:DiagramGroup):void Inflicts removing this DiagramObject from a DiagramGroup, to the original and original group rectangles.	DiagramObject
		unlink():void Removes all link references (master and target anchor points) of this DiagramObject.	DiagramObject
		unregister():void	DiagramObject
		updateAnchorsPlacement(newbox:Rectangle = null, oldbox:Rectangle = null):void Updates the placement of all the anchors attached to this DiagramObject after it has been resized.	DiagramObject
		updateAnnotationScope():void Updates the DiagramAnnotation attached to this DiagramObject after a change in its scope.	DiagramObject
		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 this DiagramObject according to its scope by applying the `updateScope()` method on each of its anchors.	DiagramObject
		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
		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 DiagramObject and/or sizes and positions its children.	DiagramObject

Property detail

_allowannotation

property

protected var _allowannotation:Boolean = true

Indicates whether annotation is supported by this DiagramObject.

allowannotation

property

allowannotation:Boolean [read-only]

Indicates whether annotation is allowed for this DiagramObject.

Implementation
public function get allowannotation():Boolean

_allowcomposite

property

protected var _allowcomposite:Boolean = false

Indicates whether this DiagramObject can be a composite (result of a composition of objects).

allowcomposite

property

allowcomposite:Boolean [read-only]

Indicates whether this DiagramObject can be a composite (holding composition members).

Implementation
public function get allowcomposite():Boolean

_allowcomposition

property

protected var _allowcomposition:Boolean = false

Indicates whether this DiagramObject can be a member of a composition.

allowcomposition

property

allowcomposition:Boolean [read-only]

Indicates whether this DiagramObject can be part of a composition.

Implementation
public function get allowcomposition():Boolean

allowgrouping

property

allowgrouping:Boolean [read-only]

Indicates whether grouping is allowed for this DiagramObject.

Implementation
public function get allowgrouping():Boolean

_allowinputlinks

property

protected var _allowinputlinks:Boolean = true

Indicates whether input links are allowed for this DiagramObject.

allowinputlinks

property

allowinputlinks:Boolean [read-only]

Indicates whether input links are allowed for this DiagramObject.

Implementation
public function get allowinputlinks():Boolean

_allowoutputlinks

property

protected var _allowoutputlinks:Boolean = true

Indicates whether output links are allowed for this DiagramObject.

allowoutputlinks

property

allowoutputlinks:Boolean [read-only]

Indicates whether output links are allowed for this DiagramObject.

Implementation
public function get allowoutputlinks():Boolean

_anchors

property

protected var _anchors:Object = null

Array of DiagramLink linked to this DiagramObject

anchors

property

anchors:Array [read-only]

An array containing the AnchorPoints of this DiagramObject.

Implementation
public function get anchors():Array

_annotation

property

protected var _annotation:DiagramAnnotation = null

Annotation attached to this DiagramObject.

annotation

property

annotation:DiagramAnnotation [read-only]

DiagramAnnotation belonging to this DiagramObject.

Implementation
public function get annotation():DiagramAnnotation

__annotationid

property

protected var __annotationid:String = "null"

Annotation ID of this DiagramObject where this DiagramObject is a DiagramAnnotation.

canShowLinkBar

property

canShowLinkBar:Boolean [read-only]Implementation
public function get canShowLinkBar():Boolean

column

property

column:DiagramColumn [read-write]

Diagram Column to which this DiagramObject belongs.

Implementation
public function get column():DiagramColumn
public function set column(value:DiagramColumn):void

_columnAffiliation

property

protected var _columnAffiliation:DiagramColumn

Diagram Column to which this DiagramObject belongs.

_compositeBounds

property

protected var _compositeBounds:Array = null

_compositionBoundIndex

property

protected var _compositionBoundIndex:int = -1

compositionBoundIndex

property

compositionBoundIndex:int [read-only]

Position of object in composition.

Implementation
public function get compositionBoundIndex():int

compositionElements

property

compositionElements:int [read-only]Implementation
public function get compositionElements():int

currentcolumn

property

currentcolumn:DiagramColumn [read-only]

The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .

Implementation
public function get currentcolumn():DiagramColumn

currentscope

property

currentscope:DiagramLane [read-only]

The current scope of this DiagramObject which is the DiagramLane containing the DiagramLayer container .

Implementation
public function get currentscope():DiagramLane

dataobjectid

property

dataobjectid:String [read-write]

Data object id of the diagram object. The dataobjectid is a way to store external key to link diagram objects to application data objects.

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

did

property

did:String [read-write]

The diagram unique identifier of this DiagramObject.

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

dragenabled

property

dragenabled:Boolean [read-only]

Tells if the diagram object is drag enabled.

Implementation
public function get dragenabled():Boolean

_dragging

property

protected var _dragging:Boolean = false

Indicates whether this DiagramObject is curretly being dragged.

dragging

property

dragging:Boolean [read-write]

Indicates whether this DiagramObject is currently being dragged.

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

_grouped

property

protected var _grouped:Boolean = false

Indicates whether this DiagramObject is a group.

grouped

property

grouped:Boolean [read-write]

Indicates whether this DiagramObject belongs to a DiagramGroup.

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

innerbottom

property

innerbottom:Number [read-only]Implementation
public function get innerbottom():Number

innerbox

property

innerbox:Rectangle [read-only]

The rectangle specified by the innerleft, innertop, innerwidth and innerheight properties.

Implementation
public function get innerbox():Rectangle

innercenter

property

innercenter:Point [read-only]Implementation
public function get innercenter():Point

innerheight

property

innerheight:Number [read-only]

The inner height of this DiagramObject.

Implementation
public function get innerheight():Number

innerleft

property

innerleft:Number [read-only]

The inner left position (X coordinate).

Implementation
public function get innerleft():Number

innerright

property

innerright:Number [read-only]Implementation
public function get innerright():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 DiagramObject.

Implementation
public function get innerwidth():Number

innerxcenter

property

innerxcenter:Number [read-only]Implementation
public function get innerxcenter():Number

innerycenter

property

innerycenter:Number [read-only]Implementation
public function get innerycenter():Number

inputlinks

property

inputlinks:Array [read-only]

Implementation
public function get inputlinks():Array

lane

property

lane:DiagramLane [read-only]

The DiagagramLane that contains thsi DiagramObject.

Implementation
public function get lane():DiagramLane

_lastmatrix

property

protected var _lastmatrix:Matrix = null

Last transformation matrix used to define the position and the size of this DiagramObject.

_layer

property

protected var _layer:DiagramLayer = null

Layer in which this DiagramObject is embedded.

layer

property

layer:DiagramLayer [read-write]

The DiagramLayer that contains this DiagramObject.

Implementation
public function get layer():DiagramLayer
public function set layer(value:DiagramLayer):void

__layerid

property

protected var __layerid:String = "null"

Layer ID of this DiagramObject where this DiagramObject is a DiagramLayer.

_loading

property

protected var _loading:Boolean = false

Indicates whether the DiagramObject is currently loading.

property

loading:Boolean [read-only]

Indicates whether the DiagramObject is currently loading.

Implementation
public function get loading():Boolean

_master

property

protected var _master:AnchorPoint = null

Master anchor point of this DiagramObject used to anchor DiagramAnnotation and DiagramLink components.

master

property

master:AnchorPoint [read-only]

Master AnchorPoint of this DiagramObject.

Implementation
public function get master():AnchorPoint

__masterid

property

protected var __masterid:String = "null"

Master Anchor ID of this DiagramObject where this DiagramObject is a AnchorPoint.

masterobject

property

masterobject:DiagramObject [read-only]

Master DiagramObject to which the master AnchorPoint depends.

Implementation
public function get masterobject():DiagramObject

_moveInsideMaster

property

protected var _moveInsideMaster:Boolean = false

Indicates whether this DiagramObject move inside his master.

moveInsideMaster

property

moveInsideMaster:Boolean [read-write]

If true, the object must move inside his master innerbox.

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

_ogrect

property

protected var _ogrect:Rectangle = null

Original surrounding rectangle of the DiagramGroup to which this DiagramObject belongs.

_orect

property

protected var _orect:Rectangle = null

Original surrounding rectangle of this DiagramObject.

outputlinks

property

outputlinks:Array [read-only]

Implementation
public function get outputlinks():Array

_resizeenabled

property

protected var _resizeenabled:Boolean = true

Indicates whether this DiagramObject is resizable.

resizeenabled

property

resizeenabled:Boolean [read-write]

Tells if the diagram object is resize enabled.

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

__savedColumn

property

protected var __savedColumn:DiagramColumn = null

__savedlayer

property

protected var __savedlayer:DiagramLayer = null

Layer to which this DiagramObject belongs to without considering user runtime modifications.

scaleAsMaster

property

scaleAsMaster:Boolean [read-only]

If true, the object scale as his master.

Implementation
public function get scaleAsMaster():Boolean

_selectable

property

protected var _selectable:Boolean = true

Indicates whether this DiagramObject is selectable.

selectable

property

selectable:Boolean [read-write]

Tells if the diagram object is selectable.

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

_selected

property

protected var _selected:Boolean = false

Indicates whether this DiagramObject is selected.

selected

property

selected:Boolean [read-write]

Indicates whether this DiagramObject is currently selected.

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

_selectedByMouseOver

property

protected var _selectedByMouseOver:Boolean = false

true if object was selected by mouse over

sprite

property

sprite:Sprite [read-only]

This DiagramObject casted as Sprite instance.

Implementation
public function get sprite():Sprite

_stayInsideMaster

property

protected var _stayInsideMaster:Boolean = true

Indicates whether this DiagramObject stay inside his master.

stayInsideMaster

property

stayInsideMaster:Boolean [read-write]

If true, the object must stay inside his master innerbox.

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

toplevelgroup

property

toplevelgroup:DiagramGroup [read-only]

The top level DiagramGroup in which this DiagramObject is embedded.

Implementation
public function get toplevelgroup():DiagramGroup

_transformui

property

protected var _transformui:DiagramObjectUI = null

Transform UI that can be used only in transform mode.

transformUILocked

property

transformUILocked:Boolean [read-only]Implementation
public function get transformUILocked():Boolean

_ui

property

protected var _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...).

property

ui:DiagramObjectUI [read-only]

The DiagramObjectUI controlling this DiagramObject.

Implementation
public function get ui():DiagramObjectUI

_view

property

protected var _view:DiagramView = null

Diagram View to which this DiagramObject belongs.

view

property

view:DiagramView [read-only]

The DiagramView that contains this DiagramObject.

Implementation
public function get view():DiagramView

property

protected var _x:Number

X coordinate of this DiagramObject.

property

x:Number [read-write]

The absolute horizontal coordinate of this DiagramObject.

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

property

protected var _y:Number

Y coordinate of this DiagramObject.

property

y:Number [read-write]

The absolute vertical coordinate of this DiagramObject.

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

Constructor detail

DiagramObject

()

constructor

public function DiagramObject(view:DiagramView)

Creates a new DiagramObject instance.

Parameters

view:DiagramView — The DiagramView that contains this DiagramObject.

Method detail

activateTransformUI

()

method

public function activateTransformUI(a:Boolean):void

Activates or deactivates the Transform UI in Transform Mode. An activated DiagramObject interacts with mouse events and a deactivated one doesn't.

Parameters

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

activateUI

()

method

public function activateUI(a:Boolean):void

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

Parameters

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

addChildAt

()

method

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

	`child:DisplayObject`

	`idx:int`

Returns

DisplayObject

anchorRemoved

()

method

public function anchorRemoved(anchor:AnchorPoint):void

Removes an AnchorPoint from this DiagramObject AnchorPoints array.

Parameters

anchor:AnchorPoint — AnchorPoint to be removed.

applyTransform

()

method

protected function applyTransform(matrix:Matrix, update:Boolean = true):void

Applies the transformation matrix matrix to this DiagramObject component.

Parameters

	`matrix:Matrix` — A transformation matrix.

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

checkTagName

()

method

public function checkTagName(xml:XML):Boolean

Checks if an XML object tag name is equal to this DiagramObject tag name.

Parameters

xml:XML — The XML object to verify.

Returns

Boolean — true if the XML object tag name matches this DiagramObjet tag name and false otherwise.

cleanup

()

method

public function cleanup():void

Cleans up listeners.

clearTransformUI

()

method

public function clearTransformUI():void

clearUI

()

method

public function clearUI():void

Hides UI elements (knobs, link bar, etc) until next screen update

createAnchor

()

method

public function createAnchor(target:DiagramObject):AnchorPoint

Creates a new AnchorPoint having this DiagramObject as master and target as target.

Parameters

target:DiagramObject — The target of the created AnchorPoint.

Returns

AnchorPoint — The created AnchorPoint.

createAnnotation

()

method

public function createAnnotation():DiagramAnnotation

Creates a DiagramAnnotation

Returns

DiagramAnnotation

createTransformUI

()

method

protected function createTransformUI():DiagramObjectUI

Creates the TransformUI controlling this DiagramObject component.

Returns

DiagramObjectUI — DiagramObjectUI instance defining the UI controller of this DiagramObject.

createUI

()

method

protected function createUI():DiagramObjectUI

Creates the DiagramObjectUI controlling this DiagramObject component.

Returns

DiagramObjectUI — DiagramObjectUI instance defining the UI controller of this DiagramObject.

doDrag

()

method

public function doDrag(event:MouseEvent):void

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

Parameters

event:MouseEvent — A MouseEvent.

dragStarted

()

method

public function dragStarted(event:MouseEvent):void

Notifies the start of a dragging operation of this DiagramObject.

Parameters

event:MouseEvent — Deteced MouseEvent.

dragStopped

()

method

public function dragStopped(event:MouseEvent):void

Notifies that the dragging operation of this DiagramObject is stopped and inflicts results to it.

Parameters

event:MouseEvent — Detected MouseEvent.

fromXML

()

method

public function fromXML(xml:XML):void

Parses this DiagramObject from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramObject.

getLinkableSpriteIDs

()

method

public function getLinkableSpriteIDs():Array

Returns an array of available groups of linkable Sprite IDs. It can be used for populating GrideddButtonBar components for example.

Returns

Array — Array of Sprite IDs groups.

getLinks

()

method

protected function getLinks(input:Boolean):Array

Returns DiagramLinks whose source or target is this object

Parameters

input:Boolean — if true searches DiagramLinks whose target is this object, source otherwise

Returns

Array — an Array of DiagramLinks

getTagName

()

method

public function getTagName():String

Returns This DiagramObject tagname.

Returns

String — This DiagramGroup tagname.

grouping

()

method

public function grouping(group:DiagramGroup):void

Inflicts adding this DiagramObject to a DiagramGroup, to the original and original group rectangles by updating their values.

Parameters

group:DiagramGroup — DiagramGroup to which this DiagramObject will be added.

groupSizing

()

method

public function groupSizing(w:Number, h:Number, update:Boolean = true):void

Inflicts DiagramGroup sizing to this DiagramObject if this DiagramObject belongs to that DiagramGroup.

Parameters

	`w:Number` — New DiagramGroup width.

	`h:Number` — New DiagramGroup height.

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

hitTest

()

method

public function hitTest(p:Point, strict:Boolean = false, selectableOnly:Boolean = false):Boolean

Evaluates the DiagramObject to see if it overlaps or intersects with the specified point.

Parameters

	`p:Point` — The point to test against this object. In DiagramObject the parameter `strict` is not used and the check is always performed against the actual pixels of the DiagramObject.

	`strict:Boolean` (default = `false`) — Whether to check against the actual pixels of the DiagramObject (`true`) or the bounding box (`false`).

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

Returns

Boolean — true if the display DiagramObject or intersects with the specified point; false otherwise.

hitTestUI

()

method

public function hitTestUI(p:Point):int

Determines the Diagram hit type given a point (cursor hit position) meaning determining what the cursor hits. The hitTest function returns a Diagram Hit type index defined in the DiagramHitType class or its DiagramObjectUI controller.

Parameters

p:Point — Hit point (cursor hit position).

Returns

int — Diagram Hit Type index (DiagramHitType.NONE)

intersectsRect

()

method

public function intersectsRect(rect:Rectangle):Boolean

Indicates whether the DiagramObject intersects with a given rectangle.

Parameters

rect:Rectangle — A rectangle.

Returns

Boolean — true if the DiagramObject intersects with the rectangle and false otherwise.

isInsideRect

()

method

public function isInsideRect(rect:Rectangle):Boolean

Indicates whether the DiagramObject is inside a given rectangle.

Parameters

rect:Rectangle — A rectangle.

Returns

Boolean — true if the DiagramObject is inside the rectangle and false otherwise.

libraryStylesChanged

()

method

public function 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..

Parameters

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

linkCreated

()

method

public function linkCreated():void

masterAnchorPointUpdated

()

method

public function masterAnchorPointUpdated(anchor:AnchorPoint):void

Changes the position of this DiagramObject component after that its AnchorPoint has been updated.

Parameters

anchor:AnchorPoint — An AnchorPoint.

masterRemoved

()

method

public function masterRemoved(anchor:AnchorPoint):void

Removes this AnchorPoint from its target object.

Parameters

anchor:AnchorPoint

masterUpdated

()

method

public function masterUpdated(anchor:AnchorPoint, scaleX:Number = 1, scaleY:Number = 1):voidParameters

	`anchor:AnchorPoint`

	`scaleX:Number` (default = `1`)

	`scaleY:Number` (default = `1`)

notifyScopeChanged

()

method

public function notifyScopeChanged():void

Detects and notifies changes in the scope of this DiagramObject. The scope change concerns changes on:

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

redispatchEvent

()

method

public function redispatchEvent(event:Event):void

Redispatches a received event to the DiagramObjectUI controlling this DiagramObject _ui.

Parameters

event:Event — Received Event.

releaseActionBounds

()

method

public function releaseActionBounds(index:int):voidParameters

index:int

setPlacement

()

method

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

Changes the location and size of this DiagramObject 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 function setPosition(px:Number, py:Number, silent:Boolean = false):void

Adjusts the location of the DiagramObject, as determined by its top-left corner, to the specified position and calls the updateAnchorsPlacement() and updateScope() methods.

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 function syncReferences():void

toXML

()

method

public function toXML():XML

Writes this DiagramObject into an XML object.

Returns

XML — An XML object representing this DiagramObject.

uiCompleted

()

method

public function uiCompleted():void

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

ungrouping

()

method

public function ungrouping(group:DiagramGroup):void

Inflicts removing this DiagramObject from a DiagramGroup, to the original and original group rectangles.

Parameters

group:DiagramGroup — DiagramGroup from which this DiagramObject will be removed.

unlink

()

method

public function unlink():void

Removes all link references (master and target anchor points) of this DiagramObject.

unregister

()

method

public function unregister():void

updateAnchorsPlacement

()

method

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

Updates the placement of all the anchors attached to this DiagramObject after it has been resized.

Parameters

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

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

updateAnnotationScope

()

method

public function updateAnnotationScope():void

Updates the DiagramAnnotation attached to this DiagramObject after a change in its scope. The scope change concerns changes on:

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

updateColumnScope

()

method

public function updateColumnScope(fitContent:Boolean = true):void

Updates Column Scope.

Parameters

fitContent:Boolean (default = true)

updateDisplayList

()

method

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

Draws the DiagramObject 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.

updateGlobalLinksPlacement

()

method

public function updateGlobalLinksPlacement():void

Updates the placement of the DiagramLink objects linked to this DiagramObject.

updateLinksScope

()

method

public function updateLinksScope():void

Updates links of this DiagramObject 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

updateScope

()

method

public function 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

updateStyle

()

method

public function updateStyle():void

Updates this DiagramObject style according to its scope (layer and dependancy to lane or panel).

updateUI

()

method

public function updateUI():void

Marks this DiagramObject so that its updateDisplayList() method gets called during a later screen update.

updateUILayer

()

method

public function 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).

Parameters

	`sourcelayer:DiagramLayer` — Source layer containing the source DiagramObject of this DiagramLink.

	`targetlayer:DiagramLayer` — Target layer containing the target DiagramObject of this DiagramLink.

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

Package	com.kapit.diagram.view
Class	public class DiagramObject
Inheritance	DiagramObject mx.core.UIComponent
Implements	IDiagramElement
Subclasses	DiagramGroup, DiagramLink, DiagramSprite