more asdoc
Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/335efead Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/335efead Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/335efead Branch: refs/heads/develop Commit: 335efead862d69873a419a19b3226d0ebec031a9 Parents: 7038391 Author: Alex Harui <aha...@apache.org> Authored: Tue Feb 4 12:38:10 2014 -0800 Committer: Alex Harui <aha...@apache.org> Committed: Wed Feb 5 21:59:33 2014 -0800 ---------------------------------------------------------------------- .../flex/html/staticControls/DropDownList.as | 78 ++++++++++++++++++++ .../apache/flex/html/staticControls/Label.as | 52 ++++++++++++- .../apache/flex/html/staticControls/TextArea.as | 41 ++++++++++ .../flex/html/staticControls/TextButton.as | 41 ++++++++++ .../flex/html/staticControls/TextInput.as | 41 ++++++++++ 5 files changed, 251 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/335efead/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/DropDownList.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/DropDownList.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/DropDownList.as index 57f1a88..4ae7405 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/DropDownList.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/DropDownList.as @@ -20,36 +20,114 @@ package org.apache.flex.html.staticControls { import org.apache.flex.core.ISelectionModel; + //-------------------------------------- + // Events + //-------------------------------------- + + /** + * Dispatched when the user selects an item. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ [Event(name="change", type="org.apache.flex.events.Event")] + /** + * The DropDownList class implements the basic equivalent of + * the <code><select></code> tag in HTML. + * The default implementation only lets the user see and + * choose from an array of strings. More complex controls + * would display icons as well as strings, or colors instead + * of strings or just about anything. + * + * The default behavior only lets the user choose one and + * only one item. More complex controls would allow + * mutiple selection by not dismissing the dropdown as soon + * as a selection is made. + * + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class DropDownList extends Button { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function DropDownList() { } + /** + * The data set to be displayed. Usually a simple + * array of strings. A more complex component + * would allow more complex data and data sets. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get dataProvider():Object { return ISelectionModel(model).dataProvider; } + + /** + * @private + */ public function set dataProvider(value:Object):void { ISelectionModel(model).dataProvider = value; } + /** + * @copy org.apache.flex.core.ISelectionModel#selectedIndex + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get selectedIndex():int { return ISelectionModel(model).selectedIndex; } + + /** + * @private + */ public function set selectedIndex(value:int):void { ISelectionModel(model).selectedIndex = value; } + + /** + * @copy org.apache.flex.core.ISelectionModel#selectedItem + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get selectedItem():Object { return ISelectionModel(model).selectedItem; } + + /** + * @private + */ public function set selectedItem(value:Object):void { ISelectionModel(model).selectedItem = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/335efead/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/Label.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/Label.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/Label.as index 30565d6..4702274 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/Label.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/Label.as @@ -23,44 +23,92 @@ package org.apache.flex.html.staticControls import org.apache.flex.events.Event; import org.apache.flex.events.IEventDispatcher; - /** + /* * Label probably should extend TextField directly, * but the player's APIs for TextLine do not allow * direct instantiation, and we might want to allow * Labels to be declared and have their actual * view be swapped out. */ - public class Label extends UIBase + + /** + * The Label class implements the basic control for labeling + * other controls. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public class Label extends UIBase { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function Label() { super(); } + /** + * The text to display in the label. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get text():String { return ITextModel(model).text; } + + /** + * @private + */ public function set text(value:String):void { ITextModel(model).text = value; } + /** + * The html-formatted text to display in the label. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get html():String { return ITextModel(model).html; } + + /** + * @private + */ public function set html(value:String):void { ITextModel(model).html = value; } + /** + * @private + */ override public function set width(value:Number):void { super.width = value; IEventDispatcher(model).dispatchEvent( new Event("widthChanged") ); } + /** + * @private + */ override public function set height(value:Number):void { super.height = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/335efead/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextArea.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextArea.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextArea.as index b8bb750..b1cd581 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextArea.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextArea.as @@ -21,26 +21,67 @@ package org.apache.flex.html.staticControls import org.apache.flex.core.ITextModel; import org.apache.flex.core.UIBase; + /** + * The TextArea class implements the basic control for + * multi-line text input. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class TextArea extends UIBase { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function TextArea() { super(); } + /** + * @copy org.apache.flex.html.staticControls.Label#text + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get text():String { return ITextModel(model).text; } + + /** + * @private + */ public function set text(value:String):void { ITextModel(model).text = value; } + /** + * @copy org.apache.flex.html.staticControls.Label#html + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get html():String { return ITextModel(model).html; } + + /** + * @private + */ public function set html(value:String):void { ITextModel(model).html = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/335efead/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextButton.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextButton.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextButton.as index 5db9916..3658005 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextButton.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextButton.as @@ -20,26 +20,67 @@ package org.apache.flex.html.staticControls { import org.apache.flex.core.ITextModel; + /** + * The TextButton class implements a basic button that + * displays text. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class TextButton extends Button { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function TextButton() { super(); } + /** + * @copy org.apache.flex.html.staticControls.Label#text + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get text():String { return ITextModel(model).text; } + + /** + * @private + */ public function set text(value:String):void { ITextModel(model).text = value; } + /** + * @copy org.apache.flex.html.staticControls.Label#html + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get html():String { return ITextModel(model).html; } + + /** + * @private + */ public function set html(value:String):void { ITextModel(model).html = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/335efead/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextInput.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextInput.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextInput.as index c048564..66ae3c7 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextInput.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/TextInput.as @@ -20,26 +20,67 @@ package org.apache.flex.html.staticControls import org.apache.flex.core.ITextModel; import org.apache.flex.core.UIBase; + /** + * The TextInput class implements the basic control for + * single-line text input. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class TextInput extends UIBase { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function TextInput() { super(); } + /** + * @copy org.apache.flex.html.staticControls.Label#text + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get text():String { return ITextModel(model).text; } + + /** + * @private + */ public function set text(value:String):void { ITextModel(model).text = value; } + /** + * @copy org.apache.flex.html.staticControls.Label#html + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get html():String { return ITextModel(model).html; } + + /** + * @private + */ public function set html(value:String):void { ITextModel(model).html = value;
