com.kapit.diagram.view.DiagramAnnotation

Public Properties

	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 [read-only] A DiagramAnnotation cannot be grouped if its master is selected	DiagramAnnotation
		allowinputlinks : Boolean [read-only]	DiagramAnnotation
		allowoutputlinks : Boolean [read-only]	DiagramAnnotation
		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 The inner height of this DiagramSprite.	DiagramSprite
		innerleft : Number The inner left position (X coordinate).	DiagramSprite
		innerright : Number	DiagramObject
		innertop : Number The inner top position (Y coordinate).	DiagramSprite
		innerwidth : Number 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 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	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 [read-only] A DiagramAnnotation doesn't scale as its master	DiagramAnnotation
		selectable : Boolean Tells if the diagram object is selectable.	DiagramObject
		selected : Boolean Indicates whether this DiagramObject is currently selected.	DiagramObject
		sprite : Sprite The SVG Image, an SVGAsset, representing this DiagramSprite instance.	DiagramSprite
		spriteid : String This DiagramSprite ID equal to `"annotation"`.	DiagramAnnotation
		stayInsideMaster : Boolean [read-only]	DiagramAnnotation
		text : String Text of the DiagramAnnotation.	DiagramAnnotation
		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

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
		_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 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 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		DiagramAnnotation(view:DiagramView) Creates a new DiagramAnnotation instance.	DiagramAnnotation
		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 DiagramAnnotation from an XML object.	DiagramAnnotation
		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 DiagramAnnotation tagname equal to `"annotation"`.	DiagramAnnotation
		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 DiagramAnnotation into an XML object.	DiagramAnnotation
		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	DiagramAnnotation
		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

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	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 DiagramAnnottation properties by initializing its triggers and defining its SVGAsset (annotation SVG Asset).	DiagramAnnotation
		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
		systemLibraryStylesChanged(event:SVGAssetLibraryEvent):void Marks the DiagramAnnotation component so that its `updateDisplayList()` method gets called during a later screen update to render the new system library styles.	DiagramAnnotation
		updateDisplayList(w:Number, h:Number):void Draws the DiagramObject and/or sizes and positions its children.	DiagramObject

Property detail

allowgrouping

property

allowgrouping:Boolean [read-only]

A DiagramAnnotation cannot be grouped if its master is selected

Implementation
public function get allowgrouping():Boolean

allowinputlinks

property

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

allowoutputlinks

property

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

scaleAsMaster

property

scaleAsMaster:Boolean [read-only]

A DiagramAnnotation doesn't scale as its master

Implementation
public function get scaleAsMaster():Boolean

spriteid

property

spriteid:String [read-write]

This DiagramSprite ID equal to "annotation".

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

stayInsideMaster

property

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

text

property

text:String [read-write]

Text of the DiagramAnnotation.

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

Constructor detail

DiagramAnnotation

()

constructor

public function DiagramAnnotation(view:DiagramView)

Creates a new DiagramAnnotation instance.

Parameters

view:DiagramView — The DiagramView that contains this DiagramAnnotation.

Method detail

createSprite

()

method

protected override function createSprite(id:String):void

Builds this DiagramAnnottation properties by initializing its triggers and defining its SVGAsset (annotation SVG Asset).

Parameters

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

fromXML

()

method

public override function fromXML(xml:XML):void

Parses this DiagramAnnotation from an XML object.

Parameters

xml:XML — An XML object represeting this DiagramAnnotation.

getTagName

()

method

public override function getTagName():String

Returns This DiagramAnnotation tagname equal to "annotation".

Returns

String — This Diagramannotation tagname.

systemLibraryStylesChanged

()

method

protected function systemLibraryStylesChanged(event:SVGAssetLibraryEvent):void

Marks the DiagramAnnotation component so that its updateDisplayList() method gets called during a later screen update to render the new system library styles.

Parameters

event:SVGAssetLibraryEvent — An SVGAssetLibraryEvent event.

toXML

()

method

public override function toXML():XML

Writes this DiagramAnnotation into an XML object.

Returns

XML — An XML object representing this DiagramAnnotation.

updateColumnScope

()

method

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

fitContent:Boolean (default = true)

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

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