com.kapit.diagram.view.DiagramSprite

	Property	Defined by
		affilatedSprites : Array Sprites that are affilated logically to this DiagramSprite.	DiagramSprite
		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	DiagramSprite
		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 The rectangle specified by the `innerleft`, `innertop`, `innerwidth` and `innerheight` properties.	DiagramObject
		innercenter : Point	DiagramObject
		innerheight : Number [read-only] The inner height of this DiagramSprite.	DiagramSprite
		innerleft : Number [read-only] The inner left position (X coordinate).	DiagramSprite
		innerright : Number	DiagramObject
		innertop : Number [read-only] The inner top position (Y coordinate).	DiagramSprite
		innerwidth : Number [read-only] The inner width of this DiagramSprite.	DiagramSprite
		innerxcenter : Number	DiagramObject
		innerycenter : Number	DiagramObject
		inputlinks : Array	DiagramObject
		lane : DiagramLane The DiagagramLane that contains thsi DiagramObject.	DiagramObject
		layer : DiagramLayer [write-only] The DiagramLayer that contains this DiagramSprite.	DiagramSprite
		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
		modifications : XML [read-only]	DiagramSprite
		moveInsideMaster : Boolean If true, the object must move inside his master innerbox.	DiagramObject
		outputlinks : Array	DiagramObject
		ownerSprite : DiagramSprite Owner Sprite to which this DiagramSprite is affiflated.	DiagramSprite
		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 [read-only] The SVG Image, an SVGAsset, representing this DiagramSprite instance.	DiagramSprite
		spriteid : String This DiagramSprite ID.	DiagramSprite
		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
		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

	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
		_clickhandler : Boolean = false Indicates whether "Mouse Down" mouse event must be considered.	DiagramSprite
		_columnAffiliation : DiagramColumn Diagram Column to which this DiagramObject belongs.	DiagramObject
		_compositeBounds : Array = null	DiagramObject
		_compositionBoundIndex : int = -1	DiagramObject
		_curaction : String = "null" Current action peformed by the view ActionManger on this DiagramSprite.	DiagramSprite
		_doubleclickhandler : Boolean = false Indicates whether "Double Click" mouse event must be considered.	DiagramSprite
		_dragenabled : Boolean = true	DiagramSprite
		_dragging : Boolean = false Indicates whether this DiagramObject is curretly being dragged.	DiagramObject
		_dx : Number Horizontal coordinate of the DiagramSprite component in its parent coordinate system.	DiagramSprite
		dx : Number [read-only] The horizontal coordinate of the DiagramSprite component in its parent coordinate system.	DiagramSprite
		_dy : Number Vertical coordinate of the DiagramSprite component in its parent coordinate system.	DiagramSprite
		dy : Number [read-only] The vertical coordinate of the DiagramSprite component in its parent coordinate system.	DiagramSprite
		_feedbackstyleselector : String = ".feedback-sprite" CSS style selector (defined in the library), feedback mode	DiagramSprite
		_fillcolorfeedback : Number Color for the sprite in feedback mode	DiagramSprite
		_fillopacityfeedback : Number	DiagramSprite
		_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
		_overlay : Shape = null Shape used to highlight component.	DiagramSprite
		_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
		_svgasset : SVGAsset = null SVGAsset representing the graphical representation of this DiagramSprite component.	DiagramSprite
		_transformui : DiagramObjectUI = null Transform UI that can be used only in transform mode.	DiagramObject
		_triggers : Array = null Array of SVGElements depending to this DiagramSprite component and that triggers mouse events.	DiagramSprite
		_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

Public Methods

	Method		Defined by
		DiagramSprite(view:DiagramView) Creates a new DiagramSprite instance.	DiagramSprite
		acceptActionBounds(target:DisplayObject, nearestPoint:Point = null, reserve:Boolean = false, compositionBound:int = -1):Array	DiagramSprite
		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
		addStyleClass(styleclass:String):void	DiagramSprite
		anchorRemoved(anchor:AnchorPoint):void Removes an AnchorPoint from this DiagramObject AnchorPoints array.	DiagramObject
		appendToSVGDocument(doc:SVGSVGElement):void Adds this DiagramSprite object in SVG format to an SVGSVGElement object.	DiagramSprite
		backToMaster():void	DiagramSprite
		checkTagName(xml:XML):Boolean Checks if an XML object tag name is equal to this DiagramObject tag name.	DiagramObject
		cleanup():void Cleans up listeners.	DiagramSprite
		cleanupTriggers():void Cleans up listeners.	DiagramSprite
		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
		createMasterAnchor(dob:DiagramObject):AnchorPoint Creates a new AnchorPoint having the DiagramObject `dob` as master and this DiagramSprite object as target.	DiagramSprite
		doDrag(event:MouseEvent):void Updates the position of the DiagramObject after the dragging action is finished.	DiagramSprite
		dragStarted(event:MouseEvent):void Notifies the start of a dragging operation of this DiagramObject.	DiagramObject
		dragStopped(event:MouseEvent):void Checks if sprite stops on a link, after the dragging action is finished.	DiagramSprite
		enterComposition(master:DiagramSprite):Boolean	DiagramSprite
		fromXML(xml:XML):void Parses this DiagramSprite from an XML object.	DiagramSprite
		getActionBounds(target:DisplayObject, index:int):Rectangle	DiagramSprite
		getAffilationBounds():Rectangle	DiagramSprite
		getLinkableSpriteIDs():Array Returns an array of available groups of linkable Sprite IDs.	DiagramSprite
		getSVGShape(shapeid:String):SVGElement	DiagramSprite
		getTagName():String Returns This DiagramSprite tagname equal to `"sprite"`.	DiagramSprite
		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
		hideFeedBack():void Hides feedback effect on sprite	DiagramSprite
		hitTest(p:Point, strict:Boolean = false, selectableOnly:Boolean = false):Boolean Evaluates the DiagramSprite to see if it overlaps or intersects with the specified point.	DiagramSprite
		hitTestUI(p:Point):int Determines the Diagram hit type given a point (cursor hit position) meaning determining what the cursor hits.	DiagramObject
		initDelta():void Initializes the position (`dx`,`dx`) of the DiagramSprite component in its parent coordinate system.	DiagramSprite
		initTriggers():void Adds mouse listeners and allows required actions for this DiagramSprite component.	DiagramSprite
		intersectsRect(rect:Rectangle):Boolean Indicates whether the DiagramObject intersects with a given rectangle.	DiagramObject
		isInLink():Boolean Checks if sprite is involved in a link	DiagramSprite
		isInsideRect(rect:Rectangle):Boolean Indicates whether the DiagramObject is inside a given rectangle.	DiagramObject
		libraryStylesChanged(event:SVGAssetLibraryEvent):void Redraws this DiagramSprite when library styles and assets change given a SVGAssetLibraryEvent.	DiagramSprite
		linkCreated():void	DiagramObject
		masterAnchorPointUpdated(anchor:AnchorPoint):void Changes the position of this DiagramSprite component after that its AnchorPoint has been updated.	DiagramSprite
		masterRemoved(anchor:AnchorPoint):void Removes this DiagramSprite when is master is removed.	DiagramSprite
		masterUpdated(anchor:AnchorPoint, scaleX:Number = 1, scaleY:Number = 1):void Changes the size of this DiagramSprite component after that its master has been updated.	DiagramSprite
		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
		removeStyleClass(styleclass:String):void	DiagramSprite
		setPlacement(rect:Rectangle, update:Boolean = true):void Changes the location and size of this DiagramSprite so that its `innerbox` property fits the specified rectangle.	DiagramSprite
		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
		showFeedBack(nearestpoint:Point, compositionBound:int = -1):void Show feedback effect on sprite	DiagramSprite
		syncReferences():void	DiagramObject
		toXML():XML Writes this DiagramSprite into an XML object.	DiagramSprite
		uiCompleted():void Finalizes modifications on this DiagramSprite, transmitted by its DiagramSpriteUI.	DiagramSprite
		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.	DiagramSprite
		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
		actionDoubleClick(event:MouseEvent):void Handles "Double Click" mouse event on this DiagramSprite by triggering the current selected action in the view ActionManger.	DiagramSprite
		actionMouseDown(event:MouseEvent):void Handles "Mouse Down" mouse event on this DiagramSprite by triggering the current selected action in the view ActionManger.	DiagramSprite
		applyTransform(matrix:Matrix, update:Boolean = true):void Applies the transformation matrix `matrix` to this DiagramSprite component.	DiagramSprite
		clearHideUITimer():void	DiagramSprite
		createSprite(id:String):void Builds this DiagramSprite properties by initializing its triggers and defining its SVGAsset.	DiagramSprite
		createTransformUI():DiagramObjectUI Creates the TransformUI controlling this DiagramSprite component.	DiagramSprite
		createUI():DiagramObjectUI Creates the DiagramSpriteUI controlling this DiagramSprite component.	DiagramSprite
		getLinks(input:Boolean):Array Returns DiagramLinks whose source or target is this object	DiagramObject
		hideUI(event:TimerEvent):void	DiagramSprite
		hideUIRollOut(event:MouseEvent):void	DiagramSprite
		initSVGLinkTriggers():void	DiagramSprite
		manualLinkRollOut(event:MouseEvent):void	DiagramSprite
		manualLinkRollOver(event:MouseEvent):void	DiagramSprite
		showUIRollOver(event:MouseEvent):void	DiagramSprite
		startHideUITimer():void	DiagramSprite
		svgLinkActionRollOut(event:MouseEvent):void Handles "Roll Out" mouse event on this DiagramSprite.	DiagramSprite
		svgLinkActionRollOver(event:MouseEvent):void Handles "Roll Over" mouse event on this DiagramSprite.	DiagramSprite
		updateDisplayList(w:Number, h:Number):void Draws the DiagramObject and/or sizes and positions its children.	DiagramObject

Property detail

affilatedSprites

property

affilatedSprites:Array [read-write]

Sprites that are affilated logically to this DiagramSprite. This property can be used especially with layout constraints.

Implementation
public function get affilatedSprites():Array
public function set affilatedSprites(value:Array):void

_clickhandler

property

protected var _clickhandler:Boolean = false

Indicates whether "Mouse Down" mouse event must be considered.

_curaction

property

protected var _curaction:String = "null"

Current action peformed by the view ActionManger on this DiagramSprite.

_doubleclickhandler

property

protected var _doubleclickhandler:Boolean = false

Indicates whether "Double Click" mouse event must be considered.

_dragenabled

property

protected var _dragenabled:Boolean = true

dragenabled

property

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

_dx

property

protected var _dx:Number

Horizontal coordinate of the DiagramSprite component in its parent coordinate system.

property

dx:Number [read-only]

The horizontal coordinate of the DiagramSprite component in its parent coordinate system.

Implementation
protected function get dx():Number

_dy

property

protected var _dy:Number

Vertical coordinate of the DiagramSprite component in its parent coordinate system.

property

dy:Number [read-only]

The vertical coordinate of the DiagramSprite component in its parent coordinate system.

Implementation
protected function get dy():Number

_feedbackstyleselector

property

protected var _feedbackstyleselector:String = ".feedback-sprite"

CSS style selector (defined in the library), feedback mode

_fillcolorfeedback

property

protected var _fillcolorfeedback:Number

Color for the sprite in feedback mode

_fillopacityfeedback

property

protected var _fillopacityfeedback:Number

innerheight

property

innerheight:Number [read-only]

The inner height of this DiagramSprite.

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

Implementation
public function get innerwidth():Number

layer

property

layer:DiagramLayer [write-only]

The DiagramLayer that contains this DiagramSprite.

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

modifications

property

modifications:XML [read-only]Implementation
public function get modifications():XML

_overlay

property

protected var _overlay:Shape = null

Shape used to highlight component.

ownerSprite

property

ownerSprite:DiagramSprite [read-write]

Owner Sprite to which this DiagramSprite is affiflated.

Implementation
public function get ownerSprite():DiagramSprite
public function set ownerSprite(value:DiagramSprite):void

sprite

property

sprite:Sprite [read-only]

The SVG Image, an SVGAsset, representing this DiagramSprite instance.

Implementation
public function get sprite():Sprite

spriteid

property

spriteid:String [read-write]

This DiagramSprite ID.

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

_svgasset

property

protected var _svgasset:SVGAsset = null

SVGAsset representing the graphical representation of this DiagramSprite component.

_triggers

property

protected var _triggers:Array = null

Array of SVGElements depending to this DiagramSprite component and that triggers mouse events.

Constructor detail

DiagramSprite

()

constructor

public function DiagramSprite(view:DiagramView)

Creates a new DiagramSprite instance.

Parameters

view:DiagramView — The DiagramView that contains this DiagramSprite.

Method detail

acceptActionBounds

()

method

public function acceptActionBounds(target:DisplayObject, nearestPoint:Point = null, reserve:Boolean = false, compositionBound:int = -1):Array

Parameters

	`target:DisplayObject`

	`nearestPoint:Point` (default = `null`)

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

	`compositionBound:int` (default = `-1`)

Returns

Array

actionDoubleClick

()

method

protected function actionDoubleClick(event:MouseEvent):void

Handles "Double Click" mouse event on this DiagramSprite by triggering the current selected action in the view ActionManger.

Parameters

event:MouseEvent — Detected Mouse Event (Double Click).

actionMouseDown

()

method

protected function actionMouseDown(event:MouseEvent):void

Handles "Mouse Down" mouse event on this DiagramSprite by triggering the current selected action in the view ActionManger.

Parameters

event:MouseEvent — Detected Mouse Event (Mouse Down).

addStyleClass

()

method

public function addStyleClass(styleclass:String):voidParameters

styleclass:String

appendToSVGDocument

()

method

public function appendToSVGDocument(doc:SVGSVGElement):void

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

Parameters

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

applyTransform

()

method

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

Applies the transformation matrix matrix to this DiagramSprite component.

Parameters

	`matrix:Matrix` — A transformation matrix.

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

backToMaster

()

method

public function backToMaster():void

cleanup

()

method

public override function cleanup():void

Cleans up listeners.

cleanupTriggers

()

method

public function cleanupTriggers():void

Cleans up listeners.

clearHideUITimer

()

method

protected function clearHideUITimer():void

createMasterAnchor

()

method

public function createMasterAnchor(dob:DiagramObject):AnchorPoint

Creates a new AnchorPoint having the DiagramObject dob as master and this DiagramSprite object as target.

Parameters

dob:DiagramObject — The master of the created AnchorPoint.

Returns

AnchorPoint — The created AnchorPoint.

createSprite

()

method

protected function createSprite(id:String):void

Builds this DiagramSprite properties by initializing its triggers and defining its SVGAsset.

Parameters

id:String — SVGAsset ID that defines the SVG Image representing this DiagramSprite.

createTransformUI

()

method

protected override function createTransformUI():DiagramObjectUI

Creates the TransformUI controlling this DiagramSprite component.

Returns

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

createUI

()

method

protected override function createUI():DiagramObjectUI

Creates the DiagramSpriteUI controlling this DiagramSprite component.

Returns

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

doDrag

()

method

public override function doDrag(event:MouseEvent):void

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

Parameters

event:MouseEvent — A MouseEvent.

dragStopped

()

method

public override function dragStopped(event:MouseEvent):void

Checks if sprite stops on a link, after the dragging action is finished.

Parameters

event:MouseEvent — A MouseEvent.

enterComposition

()

method

public function enterComposition(master:DiagramSprite):BooleanParameters

master:DiagramSprite

Returns

Boolean

fromXML

()

method

public override function fromXML(xml:XML):void

Parses this DiagramSprite from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramSprite.

getActionBounds

()

method

public function getActionBounds(target:DisplayObject, index:int):RectangleParameters

	`target:DisplayObject`

	`index:int`

Returns

Rectangle

getAffilationBounds

()

method

public function getAffilationBounds():Rectangle

Returns

Rectangle

getLinkableSpriteIDs

()

method

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

getSVGShape

()

method

public function getSVGShape(shapeid:String):SVGElementParameters

shapeid:String

Returns

SVGElement

getTagName

()

method

public override function getTagName():String

Returns This DiagramSprite tagname equal to "sprite".

Returns

String — This DiagramSprite tagname.

hideFeedBack

()

method

public function hideFeedBack():void

Hides feedback effect on sprite

hideUI

()

method

protected function hideUI(event:TimerEvent):voidParameters

event:TimerEvent

hideUIRollOut

()

method

protected function hideUIRollOut(event:MouseEvent):voidParameters

event:MouseEvent

hitTest

()

method

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

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

Parameters

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

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

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

Returns

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

initDelta

()

method

public function initDelta():void

Initializes the position (dx,dx) of the DiagramSprite component in its parent coordinate system.

initSVGLinkTriggers

()

method

protected function initSVGLinkTriggers():void

initTriggers

()

method

public function initTriggers():void

Adds mouse listeners and allows required actions for this DiagramSprite component. Initialization uses Default Link Mode

isInLink

()

method

public function isInLink():Boolean

Checks if sprite is involved in a link

Returns

Boolean — true if the sprite is involved in a link false otherwise.

libraryStylesChanged

()

method

public override function libraryStylesChanged(event:SVGAssetLibraryEvent):void

Redraws this DiagramSprite when library styles and assets change given a SVGAssetLibraryEvent.

Parameters

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

manualLinkRollOut

()

method

protected function manualLinkRollOut(event:MouseEvent):voidParameters

event:MouseEvent

manualLinkRollOver

()

method

protected function manualLinkRollOver(event:MouseEvent):voidParameters

event:MouseEvent

masterAnchorPointUpdated

()

method

public override function masterAnchorPointUpdated(anchor:AnchorPoint):void

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

Parameters

anchor:AnchorPoint — An AnchorPoint.

masterRemoved

()

method

public override function masterRemoved(anchor:AnchorPoint):void

Removes this DiagramSprite when is master is removed.

Parameters

anchor:AnchorPoint

masterUpdated

()

method

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

Changes the size of this DiagramSprite component after that its master has been updated.

Parameters

	`anchor:AnchorPoint` — An AnchorPoint.

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

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

removeStyleClass

()

method

public function removeStyleClass(styleclass:String):voidParameters

styleclass:String

setPlacement

()

method

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

Changes the location and size of this DiagramSprite so that its innerbox property fits the specified rectangle.

Parameters

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

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

showFeedBack

()

method

public function showFeedBack(nearestpoint:Point, compositionBound:int = -1):void

Show feedback effect on sprite

Parameters

	`nearestpoint:Point`

	`compositionBound:int` (default = `-1`)

showUIRollOver

()

method

protected function showUIRollOver(event:MouseEvent):voidParameters

event:MouseEvent

startHideUITimer

()

method

protected function startHideUITimer():void

svgLinkActionRollOut

()

method

protected function svgLinkActionRollOut(event:MouseEvent):void

Handles "Roll Out" mouse event on this DiagramSprite. It removes previously added event listeners (when Roll Over event was triggered) according to the current ActionManager tasks.

Parameters

event:MouseEvent — Detected Mouse Event (Roll Out).

svgLinkActionRollOver

()

method

protected function svgLinkActionRollOver(event:MouseEvent):void

Handles "Roll Over" mouse event on this DiagramSprite. It adds event listeners according to the current ActionManager tasks.

Parameters

event:MouseEvent — Detected Mouse Event (Roll Over).

toXML

()

method

public override function toXML():XML

Writes this DiagramSprite into an XML object.

Returns

XML — An XML object representing this DiagramSprite.

uiCompleted

()

method

public override function uiCompleted():void

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

updateColumnScope

()

method

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

Updates Column Scope.

Parameters

fitContent:Boolean (default = true)

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

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