Packagecom.kapit.diagram
Interfacepublic interface IDiagramElement
ImplementorsAnchorPoint, DiagramColumn, DiagramColumnContainer, DiagramLayer, DiagramObject, DiagramPanel, DiagramPanelsContainer, DiagramView

Base interface for all objects in a diagram. Most functions are used for persistence.



Public Properties
 PropertyDefined by
  dataobjectid : String
The unique key to the application data object linked with this element.
IDiagramElement
  did : String
[read-only] The diagram unique identifier of this element.
IDiagramElement
  view : DiagramView
[read-only] The diagram view of this element.
IDiagramElement
Public Methods
 MethodDefined by
  
activateUI(a:Boolean):void
Activates or deactivates this IDiagramElement.
IDiagramElement
  
checkTagName(xml:XML):Boolean
Checks if an XML object tag name is equal to this IDiagramElement tag name.
IDiagramElement
  
fromXML(xml:XML):void
Parses this IDiagramElement from an XML object.
IDiagramElement
  
getTagName():String
Returns This IDiagramElement object tagname.
IDiagramElement
  
Called when library styles and assets change given a SVGAssetLibraryEvent.
IDiagramElement
  
Ask the element to synchronize all reference after it has been loaded from XML.
IDiagramElement
  
toXML():XML
Writes this IDiagramElement into an XML object.
IDiagramElement
Property detail
dataobjectidproperty
dataobjectid:String  [read-write]

The unique key to the application data object linked with this element.

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

The diagram unique identifier of this element.

Implementation
    public function get did():String
viewproperty 
view:DiagramView  [read-only]

The diagram view of this element.

Implementation
    public function get view():DiagramView
Method detail
activateUI()method
public function activateUI(a:Boolean):void

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

Parameters
a:Boolean — The desired value of the IDiagramElement active status.
checkTagName()method 
public function checkTagName(xml:XML):Boolean

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

Parameters
xml:XML — The XML object to verify.

Returns
Booleantrue if the XML object tag name matches this IDiagramElement tag name and false otherwise.
fromXML()method 
public function fromXML(xml:XML):void

Parses this IDiagramElement from an XML object.

Parameters
xml:XML — An XML object represeting this IDiagramElement.
getTagName()method 
public function getTagName():String

Returns This IDiagramElement object tagname.

Returns
String — This IDiagramElement object tagname.
libraryStylesChanged()method 
public function libraryStylesChanged(event:SVGAssetLibraryEvent):void

Called when library styles and assets change given a SVGAssetLibraryEvent.

Parameters
event:SVGAssetLibraryEvent — SVGAssetLibraryEvent telling a change in asset library properties.
syncReferences()method 
public function syncReferences():void

Ask the element to synchronize all reference after it has been loaded from XML. This function is called after all objects of a diagram are loaded from XML.

toXML()method 
public function toXML():XML

Writes this IDiagramElement into an XML object.

Returns
XML — An XML object representing this IDiagramElement.