| Package | com.cyntaxic.cynmvc |
| Class | public class Cyntaxic |
| Inheritance | Cyntaxic  Object |
root & stage can be
referenced statically from the Cyntaxic base class. It also comes bundled with a bunch of
commonly used utility functions and a built in debugger.
| Property | Defined By | ||
|---|---|---|---|
| advancedDescribe : Boolean [static]
Makes describe function wrap advanced describe properties in a parent object. | Cyntaxic | ||
| cmLove : Boolean [static]
Sets whether or not the root contextual menu gives credit to
the Cyntaxic framework. | Cyntaxic | ||
| contextMenu : ContextMenu [static]
The root contextual menu. | Cyntaxic | ||
| CONTROLLER : CynController [static]
Returns the extended CynController instance. | Cyntaxic | ||
| debug : Boolean [static]
Sets whether or not debugging is enabled. | Cyntaxic | ||
| DEBUGGER : Debugger [static]
Returns the debugger instance. | Cyntaxic | ||
| FLASH_VARS_VO : FlashVarsVO [static]
Returns FlashVars as a value object. | Cyntaxic | ||
| fullScaleFlash : Boolean [static]
Determines whether or not the application is set for liquid layout. | Cyntaxic | ||
| MODEL : CynModel [static]
Returns the extended CynModel instance. | Cyntaxic | ||
| ROOT : DisplayObject [static]
Returns the root of the application. | Cyntaxic | ||
| STAGE : Stage [static]
Returns the stage instance of the application. | Cyntaxic | ||
| VERSION : String [static] [read-only]
Returns the version number of the framework as a string. | Cyntaxic | ||
| Method | Defined By | ||
|---|---|---|---|
addCynViewProxy(view:DisplayObject):void [static]
Adds a view to the framework that cannot extend CynComponent
or CynComposite. | Cyntaxic | ||
go(url:String, target:String):void [static]
Goes to a webpage. | Cyntaxic | ||
init(model:CynModel, controller:CynController, doc:DisplayObject = null, props:Object = null):Cyntaxic [static]
Initializes the Cyntaxic framework. | Cyntaxic | ||
initDocument(doc:DisplayObject, props:Object = null):void [static]
Initializes the document class for the Cyntaxic framework if not
available at the time Cyntaxic.init is called. | Cyntaxic | ||
removeCynViewProxy(view:DisplayObject):void [static]
Removes a proxy view from notifications from the controller. | Cyntaxic | ||
| advancedDescribe | property |
advancedDescribe:BooleanMakes describe function wrap advanced describe properties in a parent object. The parent object adds the fully qualified class, base class and length if the object described is an array. Default is false.
public static function get advancedDescribe():Boolean public static function set advancedDescribe(value:Boolean):voidSee also
| cmLove | property |
cmLove:BooleanSets whether or not the root contextual menu gives credit to the Cyntaxic framework.
public static function get cmLove():Boolean public static function set cmLove(value:Boolean):void| contextMenu | property |
contextMenu:ContextMenuThe root contextual menu.
public static function get contextMenu():ContextMenu public static function set contextMenu(value:ContextMenu):void| CONTROLLER | property |
CONTROLLER:CynController
Returns the extended CynController instance. By
convention this class should be setup as a singleton. This is a
pseudo constant as it only can be set once by the framework. Attempts
at setting will throw a CynError.
public static function get CONTROLLER():CynController public static function set CONTROLLER(value:CynController):voidCynError — If attempting to set.
|
| debug | property |
debug:BooleanSets whether or not debugging is enabled.
public static function get debug():Boolean public static function set debug(value:Boolean):void| DEBUGGER | property |
DEBUGGER:Debugger
Returns the debugger instance. The debugger has one function, log
which takes 2 arguments. The messenger and the message. The controller and views
have shortcut functions for this that assume the first argument as itself. Use this
when the intention is to override the messenger parameter. Attempts
at setting will throw an CynError.
public static function get DEBUGGER():Debugger public static function set DEBUGGER(value:Debugger):voidCynError — If attempting to set.
|
| FLASH_VARS_VO | property |
FLASH_VARS_VO:FlashVarsVO
Returns FlashVars as a value object. Attempts
at setting will throw an CynError.
public static function get FLASH_VARS_VO():FlashVarsVO public static function set FLASH_VARS_VO(value:FlashVarsVO):voidCynError — If attempting to set.
|
| fullScaleFlash | property |
fullScaleFlash:Boolean
Determines whether or not the application is set for liquid layout. If this
is not set to true CynView resize functions will not fire.
public static function get fullScaleFlash():Boolean public static function set fullScaleFlash(value:Boolean):void| MODEL | property |
MODEL:CynModel
Returns the extended CynModel instance. By
convention this class should be setup as a singleton. This is a
pseudo constant as it only can be set once by the framework. Attempts
at setting will throw a CynError.
public static function get MODEL():CynModel public static function set MODEL(value:CynModel):voidCynError — If attempting to set.
|
| ROOT | property |
ROOT:DisplayObject
Returns the root of the application. Attempts
at setting will throw an CynError.
public static function get ROOT():DisplayObject public static function set ROOT(value:DisplayObject):voidCynError — If attempting to set.
|
| STAGE | property |
STAGE:Stage
Returns the stage instance of the application. Attempts
at setting will throw an CynError.
public static function get STAGE():Stage public static function set STAGE(value:Stage):voidCynError — If attempting to set.
|
| VERSION | property |
VERSION:String [read-only] Returns the version number of the framework as a string.
public static function get VERSION():String| addCynViewProxy | () | method |
public static function addCynViewProxy(view:DisplayObject):void
Adds a view to the framework that cannot extend CynComponent
or CynComposite. This allows the view to be notified by the contoller.
Parameters
view:DisplayObject — The proxy view to be added.
|
| go | () | method |
public static function go(url:String, target:String):voidGoes to a webpage.
Parameters
url:String — The URL to go to.
| |
target:String — The window to open it in.
|
| init | () | method |
public static function init(model:CynModel, controller:CynController, doc:DisplayObject = null, props:Object = null):CyntaxicInitializes the Cyntaxic framework.
Parameters
model:CynModel — The extended CynModel class.
| |
controller:CynController — The extended CynController class.
| |
doc:DisplayObject (default = null) | |
props:Object (default = null) |
Cyntaxic — The Cyntaxic singleton instance.
|
See also
| initDocument | () | method |
public static function initDocument(doc:DisplayObject, props:Object = null):void
Initializes the document class for the Cyntaxic framework if not
available at the time Cyntaxic.init is called.
Parameters
doc:DisplayObject — The document class.
| |
props:Object (default = null) |
| removeCynViewProxy | () | method |
public static function removeCynViewProxy(view:DisplayObject):voidRemoves a proxy view from notifications from the controller.
Parameters
view:DisplayObject — The proxy view to be removed.
|