Packagecom.gestureworks.cml.core
Classpublic class CMLParser
InheritanceCMLParser Inheritance CML_CORE Inheritance Object

The CMLParser class parses cml files for run-time object construction and modification. It is called by the GestureWorks class when a cml file path is specified in the Constructor.

See also

com.gestureworks.cml.core.CMLObjectList
com.gestureworks.cml.core.CMLDisplay

Public Properties
 PropertyDefined By
  cmlData : XML
[static]
CMLParser
  cmlDisplay : DisplayObjectContainer
[static]
CMLParser
  cmlFile : String
[static]
CMLParser
  cssFile : String
[static]
CMLParser
  debug : Boolean = false
[static]
CMLParser
  instance : *
[static] [read-only]
CMLParser
  relativePaths : Boolean = false
[static]
CMLParser
  rootDirectory : String
[static]
CMLParser
Protected Properties
 PropertyDefined By
 InheritedCML_CORE_PACKAGES : Array
[static]
CML_CORE
Public Methods
 MethodDefined By
  
CMLParser()
CMLParser
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static]
CMLParser
  
attrLoop(obj:*, cml:XMLList):void
[static]
CMLParser
  
createObject(tag:String):Object
[static] Creates object from class name Returns a new object of the class
CMLParser
  
dispatchEvent(event:Event):Boolean
[static]
CMLParser
  
hasEventListener(type:String):Boolean
[static]
CMLParser
  
init(cml:XML, parent:*, properties:* = null):void
[static] Initial parsing of the cml document
CMLParser
  
loopCML(cml:XMLList, parent:* = null):void
[static] Recursive CML parsing
CMLParser
  
parseCML(obj:*, cml:XMLList):XMLList
[static] Default parseCML routine
CMLParser
  
relToAbsPath(string:String):String
[static] Converts relative to absolute path
CMLParser
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[static]
CMLParser
  
resolveAttrs(obj:Object):void
[static] Resolves expression attributes
CMLParser
  
updateProperties(obj:*, state:Number = 0):void
[static] Default updateProperties routine
CMLParser
  
willTrigger(type:String):Boolean
[static]
CMLParser
Public Constants
 ConstantDefined By
  COMPLETE : String = COMPLETE
[static]
CMLParser
Property Detail
cmlDataproperty
public static var cmlData:XML

cmlDisplayproperty 
public static var cmlDisplay:DisplayObjectContainer

cmlFileproperty 
public static var cmlFile:String

cssFileproperty 
public static var cssFile:String

debugproperty 
public static var debug:Boolean = false

instanceproperty 
instance:*  [read-only]


Implementation
    public static function get instance():*
relativePathsproperty 
public static var relativePaths:Boolean = false

rootDirectoryproperty 
public static var rootDirectory:String

Constructor Detail
CMLParser()Constructor
public function CMLParser()



Method Detail
addEventListener()method
public static function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

attrLoop()method 
public static function attrLoop(obj:*, cml:XMLList):void

Parameters

obj:*
 
cml:XMLList

createObject()method 
public static function createObject(tag:String):Object

Creates object from class name Returns a new object of the class

Parameters

tag:String

Returns
Object —
dispatchEvent()method 
public static function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
hasEventListener()method 
public static function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
init()method 
public static function init(cml:XML, parent:*, properties:* = null):void

Initial parsing of the cml document

Parameters

cml:XML
 
parent:*
 
properties:* (default = null)

loopCML()method 
public static function loopCML(cml:XMLList, parent:* = null):void

Recursive CML parsing

Parameters

cml:XMLList
 
parent:* (default = null)

parseCML()method 
public static function parseCML(obj:*, cml:XMLList):XMLList

Default parseCML routine

Parameters

obj:*
 
cml:XMLList

Returns
XMLList —
relToAbsPath()method 
public static function relToAbsPath(string:String):String

Converts relative to absolute path

Parameters

string:String

Returns
String —
removeEventListener()method 
public static function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

resolveAttrs()method 
public static function resolveAttrs(obj:Object):void

Resolves expression attributes

Parameters

obj:Object

updateProperties()method 
public static function updateProperties(obj:*, state:Number = 0):void

Default updateProperties routine

Parameters

obj:*
 
state:Number (default = 0)

willTrigger()method 
public static function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean
Constant Detail
COMPLETEConstant
public static const COMPLETE:String = COMPLETE





Tue Apr 16 2013, 03:24 PM -06:00