Packageorg.servebox.foundry.view
Classpublic class ViewHelper
InheritanceViewHelper Inheritance flash.events.EventDispatcher
ImplementsIObserver, mx.core.IMXMLObject
SubclassesAbstractDataSaveViewHelper

ViewHelper is linked to a view. ViewHelper gathering data required by the view and storing this intermediate model, ViewHelper may adapt data model for use by the view, or accesing data i nthe view ( like user input ) ViewHelpers handle notification from remote service too


Public Properties
 PropertyDefined by
  autoRegisterBasedOnQualifiedClassName : Boolean
ViewHelper
  autoRegisterBasedOnViewId : Boolean
ViewHelper
  autoRegisterToViewLocator : Boolean
Indicates whether the ViewHelper instance should register itself to the ViewHelper.
ViewHelper
Public Methods
 MethodDefined by
  
getId():String
Returns the id of the ViewHelper instance.
ViewHelper
  
getView():IView
Returns a reference to the ancestor view.
ViewHelper
  
initialized(document:Object, id:String):void
IMXMLObject API override.
ViewHelper
  
registerToModels():void
Registers the ViewHelper instance to the models.
ViewHelper
  
update(o:IObservable, n:Notification):void
Tries to find a method called notificationType_Fired( o:IObservable, notificationData : Object ):void, where notificationType is the type of the notification instance.
ViewHelper
Protected Methods
 MethodDefined by
  
initializeHelper(view:IView, id:String):void
ViewHelper
Property detail
autoRegisterBasedOnQualifiedClassNameproperty
autoRegisterBasedOnQualifiedClassName:Boolean  [read-write]Implementation
    public function get autoRegisterBasedOnQualifiedClassName():Boolean
    public function set autoRegisterBasedOnQualifiedClassName(value:Boolean):void
autoRegisterBasedOnViewIdproperty 
autoRegisterBasedOnViewId:Boolean  [read-write]Implementation
    public function get autoRegisterBasedOnViewId():Boolean
    public function set autoRegisterBasedOnViewId(value:Boolean):void
autoRegisterToViewLocatorproperty 
autoRegisterToViewLocator:Boolean  [read-write]

Indicates whether the ViewHelper instance should register itself to the ViewHelper. If not, the developer should register the instance himself. Default is true.

Implementation
    public function get autoRegisterToViewLocator():Boolean
    public function set autoRegisterToViewLocator(value:Boolean):void
Method detail
getId()method
public function getId():String

Returns the id of the ViewHelper instance.

Returns
String
getView()method 
public function getView():IView

Returns a reference to the ancestor view.

Returns
IView
initialized()method 
public function initialized(document:Object, id:String):void

IMXMLObject API override. The Flex runtime client will call this method during the first steps of the instance life-cycle (as soon as the implementing object has been created and all the component properties have been set onto the MXML tag).

Parameters
document:Object
 
id:String
initializeHelper()method 
protected function initializeHelper(view:IView, id:String):voidParameters
view:IView
 
id:String
registerToModels()method 
public function registerToModels():void

Registers the ViewHelper instance to the models. This is a do-nothing method. TODO, override.

update()method 
public function update(o:IObservable, n:Notification):void

Tries to find a method called notificationType_Fired( o:IObservable, notificationData : Object ):void, where notificationType is the type of the notification instance. Override if you want to define your own notification management.

Parameters
o:IObservable
 
n:Notification



ActionScript Foundry Bundle Project API Documentation - Generated using Adobe ASDoc / Maven Flex Plugin