Updated Branches: refs/heads/develop 9e7ec1f14 -> 89c12f705
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/89c12f70/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIBase.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIBase.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIBase.as index cdd3841..259c76d 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIBase.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIBase.as @@ -24,19 +24,52 @@ package org.apache.flex.core import org.apache.flex.events.Event; import org.apache.flex.events.IEventDispatcher; + /** + * The UIBase class is the base class for most composite user interface + * components. For the Flash Player, Buttons and Text controls may + * have a different base class and therefore may not extend UIBase. + * However all user interface components should implement IUIBase. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class UIBase extends Sprite implements IStrand, IEventDispatcher, IUIBase, IParent { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function UIBase() { super(); } private var _explicitWidth:Number; + + /** + * The explicitly set width (as opposed to measured width + * or percentage width). + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get explicitWidth():Number { return _explicitWidth; } - public function set explicitWidth(value:Number):void + + /** + * @private + */ + public function set explicitWidth(value:Number):void { if (_explicitWidth == value) return; @@ -51,10 +84,24 @@ package org.apache.flex.core } private var _explicitHeight:Number; - public function get explicitHeight():Number + + /** + * The explicitly set width (as opposed to measured width + * or percentage width). + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public function get explicitHeight():Number { return _explicitHeight; } + + /** + * @private + */ public function set explicitHeight(value:Number):void { if (_explicitHeight == value) @@ -70,10 +117,27 @@ package org.apache.flex.core } private var _percentWidth:Number; - public function get percentWidth():Number + + /** + * The requested percentage width this component + * should have in the parent container. Note that + * the actual percentage may be different if the + * total is more than 100% or if there are other + * components with explicitly set widths. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public function get percentWidth():Number { return _percentWidth; } + + /** + * @private + */ public function set percentWidth(value:Number):void { if (_percentWidth == value) @@ -86,11 +150,29 @@ package org.apache.flex.core dispatchEvent(new Event("percentWidthChanged")); } - private var _percentHeight:Number; + + private var _percentHeight:Number; + + /** + * The requested percentage height this component + * should have in the parent container. Note that + * the actual percentage may be different if the + * total is more than 100% or if there are other + * components with explicitly set heights. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get percentHeight():Number { return _percentHeight; } + + /** + * @private + */ public function set percentHeight(value:Number):void { if (_percentHeight == value) @@ -105,7 +187,19 @@ package org.apache.flex.core } private var _width:Number; - override public function get width():Number + + /** + * The width of the component. If no width has been previously + * set the default width may be specified in the IValuesImpl + * or determined as the bounding box around all child + * components and graphics. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + override public function get width():Number { if (isNaN(_width)) { @@ -116,6 +210,10 @@ package org.apache.flex.core } return _width; } + + /** + * @private + */ override public function set width(value:Number):void { if (explicitWidth != value) @@ -129,12 +227,33 @@ package org.apache.flex.core dispatchEvent(new Event("widthChanged")); } } + + /** + * Retrieve the low-level bounding box width. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected function get $width():Number { return super.width; } private var _height:Number; + + /** + * The height of the component. If no height has been previously + * set the default height may be specified in the IValuesImpl + * or determined as the bounding box around all child + * components and graphics. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ override public function get height():Number { if (isNaN(_height)) @@ -146,6 +265,10 @@ package org.apache.flex.core } return _height; } + + /** + * @private + */ override public function set height(value:Number):void { if (explicitHeight != value) @@ -159,13 +282,31 @@ package org.apache.flex.core dispatchEvent(new Event("heightChanged")); } } + + /** + * Retrieve the low-level bounding box height. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected function get $height():Number { return super.height; } private var _model:IBeadModel; - public function get model():IBeadModel + + /** + * An IBeadModel that serves as the data model for the component. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public function get model():IBeadModel { if (_model == null) { @@ -174,6 +315,10 @@ package org.apache.flex.core } return _model; } + + /** + * @private + */ public function set model(value:IBeadModel):void { if (_model != value) @@ -184,10 +329,23 @@ package org.apache.flex.core } private var _id:String; + + /** + * An id property for MXML documents. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get id():String { return _id; } + + /** + * @private + */ public function set id(value:String):void { if (_id != value) @@ -198,10 +356,24 @@ package org.apache.flex.core } private var _className:String; - public function get className():String + + /** + * The classname. Often used for CSS + * class selector lookups. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public function get className():String { return _className; } + + /** + * @private + */ public function set className(value:String):void { if (_className != value) @@ -211,16 +383,39 @@ package org.apache.flex.core } } + /** + * @see org.apache.flex.core.IUIBase#element + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get element():Object { return this; } - // beads declared in MXML are added to the strand. - // from AS, just call addBead() + /** + * @copy org.apache.flex.core.Application#beads + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var beads:Array; private var _beads:Vector.<IBead>; + + /** + * @see org.apache.flex.core.IStrand#addBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function addBead(bead:IBead):void { if (!_beads) @@ -235,6 +430,14 @@ package org.apache.flex.core } } + /** + * @see org.apache.flex.core.IStrand#getBeadByType + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function getBeadByType(classOrInterface:Class):IBead { for each (var bead:IBead in _beads) @@ -245,6 +448,14 @@ package org.apache.flex.core return null; } + /** + * @see org.apache.flex.core.IStrand#removeBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function removeBead(value:IBead):IBead { var n:int = _beads.length; @@ -260,6 +471,14 @@ package org.apache.flex.core return null; } + /** + * @see org.apache.flex.core.IParent#addElement + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function addElement(c:Object):void { if (c is IUIBase) @@ -271,6 +490,14 @@ package org.apache.flex.core addChild(c as DisplayObject); } + /** + * @see org.apache.flex.core.IParent#addElementAt + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function addElementAt(c:Object, index:int):void { if (c is IUIBase) @@ -282,6 +509,14 @@ package org.apache.flex.core addChildAt(c as DisplayObject, index); } + /** + * @see org.apache.flex.core.IParent#getElementIndex + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function getElementIndex(c:Object):int { if (c is IUIBase) @@ -290,6 +525,14 @@ package org.apache.flex.core return getChildIndex(c as DisplayObject); } + /** + * @see org.apache.flex.core.IParent#removeElement + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function removeElement(c:Object):void { if (c is IUIBase) @@ -298,6 +541,15 @@ package org.apache.flex.core removeChild(c as DisplayObject); } + /** + * The method called when added to a parent. This is a good + * time to set up beads. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function addedToParent():void { var c:Class; @@ -334,6 +586,14 @@ package org.apache.flex.core } } + /** + * A measurement bead, if one exists. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get measurementBead() : IMeasurementBead { var measurementBead:IMeasurementBead = getBeadByType(IMeasurementBead) as IMeasurementBead; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/89c12f70/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIButtonBase.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIButtonBase.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIButtonBase.as index 529cc60..860e206 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIButtonBase.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIButtonBase.as @@ -19,7 +19,6 @@ package org.apache.flex.core { import flash.display.DisplayObject; - import flash.display.DisplayObjectContainer; import flash.display.SimpleButton; import flash.events.MouseEvent; @@ -28,15 +27,46 @@ package org.apache.flex.core import org.apache.flex.core.IMeasurementBead; import org.apache.flex.core.IStrand; import org.apache.flex.core.IUIBase; - import org.apache.flex.core.UIBase; import org.apache.flex.core.ValuesManager; import org.apache.flex.events.Event; import org.apache.flex.events.IEventDispatcher; + //-------------------------------------- + // Events + //-------------------------------------- + + /** + * Set a different class for click events so that + * there aren't dependencies on the flash classes + * on the JS side. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ [Event(name="click", type="org.apache.flex.events.Event")] + /** + * The UIButtonBase class is the base class for most Buttons in a FlexJS + * application. In Flash, these buttons extend SimpleButton and therefore + * do not support all of the Sprite APIs. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class UIButtonBase extends SimpleButton implements IStrand, IEventDispatcher, IUIBase { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function UIButtonBase(upState:DisplayObject=null, overState:DisplayObject=null, downState:DisplayObject=null, hitTestState:DisplayObject=null) { super(upState, overState, downState, hitTestState); @@ -55,6 +85,15 @@ package org.apache.flex.core } private var _width:Number; + + /** + * @copy org.apache.flex.core.UIBase#width + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ override public function get width():Number { if (isNaN(_width)) @@ -66,6 +105,10 @@ package org.apache.flex.core } return _width; } + + /** + * @private + */ override public function set width(value:Number):void { if (_width != value) @@ -74,12 +117,30 @@ package org.apache.flex.core dispatchEvent(new Event("widthChanged")); } } + + /** + * Retrieve the low-level bounding box width. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected function get $width():Number { return super.width; } private var _height:Number; + + /** + * @copy org.apache.flex.core.UIBase#width + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ override public function get height():Number { if (isNaN(_height)) @@ -92,6 +153,9 @@ package org.apache.flex.core return _height; } + /** + * @private + */ override public function set height(value:Number):void { if (_height != value) @@ -100,12 +164,30 @@ package org.apache.flex.core dispatchEvent(new Event("heightChanged")); } } + + /** + * Retrieve the low-level bounding box height. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected function get $height():Number { return super.height; } private var _model:IBeadModel; + + /** + * @copy org.apache.flex.core.UIBase#model + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get model():IBeadModel { if (_model == null) @@ -115,6 +197,10 @@ package org.apache.flex.core } return _model; } + + /** + * @private + */ public function set model(value:IBeadModel):void { if (_model != value) @@ -125,10 +211,23 @@ package org.apache.flex.core } private var _id:String; + + /** + * @copy org.apache.flex.core.UIBase#id + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get id():String { return _id; } + + /** + * @private + */ public function set id(value:String):void { if (_id != value) @@ -139,10 +238,23 @@ package org.apache.flex.core } private var _className:String; - public function get className():String + + /** + * @copy org.apache.flex.core.UIBase#className + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public function get className():String { return _className; } + + /** + * @private + */ public function set className(value:String):void { if (_className != value) @@ -152,16 +264,39 @@ package org.apache.flex.core } } + /** + * @copy org.apache.flex.core.UIBase#element + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get element():Object { return this; } - // beads declared in MXML are added to the strand. - // from AS, just call addBead() + /** + * @copy org.apache.flex.core.UIBase#beads + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var beads:Array; private var strand:Vector.<IBead>; + + /** + * @copy org.apache.flex.core.UIBase#addBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function addBead(bead:IBead):void { if (!strand) @@ -172,6 +307,14 @@ package org.apache.flex.core bead.strand = this; } + /** + * @copy org.apache.flex.core.UIBase#getBeadByType + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function getBeadByType(classOrInterface:Class):IBead { for each (var bead:IBead in strand) @@ -182,6 +325,14 @@ package org.apache.flex.core return null; } + /** + * @copy org.apache.flex.core.UIBase#removeBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function removeBead(value:IBead):IBead { var n:int = strand.length; @@ -197,6 +348,14 @@ package org.apache.flex.core return null; } + /** + * @copy org.apache.flex.core.UIBase#addToParent + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function addedToParent():void { var c:Class; @@ -237,6 +396,14 @@ package org.apache.flex.core } + /** + * @copy org.apache.flex.core.UIBase#measurementBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get measurementBead() : IMeasurementBead { var measurementBead:IMeasurementBead = getBeadByType(IMeasurementBead) as IMeasurementBead; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/89c12f70/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIMetrics.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIMetrics.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIMetrics.as index 65cd424..39f798d 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIMetrics.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/UIMetrics.as @@ -18,18 +18,69 @@ //////////////////////////////////////////////////////////////////////////////// package org.apache.flex.core { + /** + * The UIMetrics class is the base class for most composite user interface + * components. For the Flash Player, Buttons and Text controls may + * have a different base class and therefore may not extend UIBase. + * However all user interface components should implement IUIBase. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class UIMetrics { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function UIMetrics() { } + /** + * The offset or position of the top of something. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var top:Number; + /** + * The offset or position of the left of something. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var left:Number; + /** + * The offset or position of the bottom of something. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var bottom:Number; + /** + * The offset or position of the right of something. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var right:Number; } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/89c12f70/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ValuesManager.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ValuesManager.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ValuesManager.as index 8bc8fa2..0c9b6fd 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ValuesManager.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ValuesManager.as @@ -18,18 +18,52 @@ //////////////////////////////////////////////////////////////////////////////// package org.apache.flex.core { + /** + * The ValuesManager class is one of the few Singleton classes in + * FlexJS. Instances of other things can be shared via IValuesImpl, but + * this class's API is its one static property where you get the + * instance of IValuesImpl by which other instances can be shared. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class ValuesManager { + /** + * Constructor. This class should not be instantiated. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function ValuesManager() { } private static var _valuesImpl:IValuesImpl; + /** + * The implementation of IValuesImpl where you can + * get default values and shared instances. + * + * @see org.apache.flex.core.IValuesImpl + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public static function get valuesImpl():IValuesImpl { return _valuesImpl; } + + /** + * @private + */ public static function set valuesImpl(value:IValuesImpl):void { _valuesImpl = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/89c12f70/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBase.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBase.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBase.as index afeb04d..6f46a62 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBase.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBase.as @@ -25,15 +25,59 @@ package org.apache.flex.core import org.apache.flex.events.ValueChangeEvent; import org.apache.flex.utils.MXMLDataInterpreter; + //-------------------------------------- + // Events + //-------------------------------------- + + /** + * Dispatched at startup. Attributes and sub-instances of + * the MXML document have been created and assigned. + * The component lifecycle is different + * than the Flex SDK. There is no creationComplete event. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ [Event(name="initComplete", type="org.apache.flex.events.Event")] + [DefaultProperty("mxmlContent")] + + /** + * The ViewBase class is the base class for most views in a FlexJS + * application. It is generally used as the root tag of MXML + * documents and UI controls and containers are added to it. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class ViewBase extends UIBase implements IPopUpHost { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function ViewBase() { super(); } + /** + * A ViewBase doesn't create its children until it is added to + * a parent, usually the application. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ override public function addedToParent():void { // each MXML file can also have styles in fx:Style block @@ -45,6 +89,14 @@ package org.apache.flex.core dispatchEvent(new Event("initComplete")) } + /** + * @copy org.apache.flex.core.Application#MXMLDescriptor + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get MXMLDescriptor():Array { return null; @@ -52,20 +104,51 @@ package org.apache.flex.core private var mxmlProperties:Array ; + /** + * @copy org.apache.flex.core.Application#generateMXMLAttributes + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function generateMXMLAttributes(data:Array):void { mxmlProperties = data; } + /** + * @copy org.apache.flex.core.ItemRendererFactory#mxmlContent + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public var mxmlContent:Array; private var _applicationModel:Object; [Bindable("modelChanged")] + + /** + * A reference to the Application's model. Usually, + * a view is displaying the main model for an + * application. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get applicationModel():Object { return _applicationModel; } + + /** + * @private + */ public function set applicationModel(value:Object):void { _applicationModel = value; @@ -74,10 +157,23 @@ package org.apache.flex.core private var _states:Array; + /** + * The array of view states. These should + * be instances of mx.states.State. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get states():Array { return _states; } + + /** + * @private + */ public function set states(value:Array):void { _states = value; @@ -93,6 +189,18 @@ package org.apache.flex.core } + /** + * <code>true</code> if the array of states + * contains a state with this name. + * + * @param String state The state namem. + * @return Boolean True if state in state array + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function hasState(state:String):Boolean { for each (var s:State in _states) @@ -105,10 +213,22 @@ package org.apache.flex.core private var _currentState:String; + /** + * The name of the current state. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get currentState():String { return _currentState; } + + /** + * @private + */ public function set currentState(value:String):void { var event:ValueChangeEvent = new ValueChangeEvent("currentStateChanged", false, false, _currentState, value) @@ -118,10 +238,22 @@ package org.apache.flex.core private var _transitions:Array; + /** + * The array of transitions. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get transitions():Array { return _transitions; } + + /** + * @private + */ public function set transitions(value:Array):void { _transitions = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/89c12f70/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBaseDataBinding.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBaseDataBinding.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBaseDataBinding.as index 0bff3a4..b75cd78 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBaseDataBinding.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/core/ViewBaseDataBinding.as @@ -28,14 +28,44 @@ package org.apache.flex.core import org.apache.flex.events.Event; import org.apache.flex.events.IEventDispatcher; + /** + * The ViewBaseDataBinding class implements databinding for + * ViewBase instances. Different classes can have + * different databinding implementation that optimize for + * the different lifecycles. For example, an item renderer + * databinding implementation can wait to execute databindings + * until the data property is set. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class ViewBaseDataBinding implements IBead { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function ViewBaseDataBinding() { super(); } private var _strand:IStrand; + + /** + * @see org.apache.flex.core.IBead#strand. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value;
