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/c74fe5ff Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/c74fe5ff Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/c74fe5ff Branch: refs/heads/develop Commit: c74fe5fffe94ab5dceac886d7317b98167b76c18 Parents: 335efea Author: Alex Harui <aha...@apache.org> Authored: Tue Feb 4 15:14:57 2014 -0800 Committer: Alex Harui <aha...@apache.org> Committed: Wed Feb 5 21:59:35 2014 -0800 ---------------------------------------------------------------------- .../html/staticControls/beads/CSSButtonView.as | 31 ++++++- .../staticControls/beads/CSSTextButtonView.as | 52 ++++++++++++ .../html/staticControls/beads/CheckBoxView.as | 87 +++++++++++++++++++- .../html/staticControls/beads/ContainerView.as | 77 ++++++++++++++++- .../DataItemRendererFactoryForArrayData.as | 53 +++++++++++- .../staticControls/beads/DownArrowButtonView.as | 25 ++++++ .../staticControls/beads/DropDownListView.as | 60 ++++++++++++++ .../staticControls/beads/IBackgroundBead.as | 9 ++ .../html/staticControls/beads/IBorderBead.as | 9 ++ .../staticControls/beads/IDropDownListView.as | 26 ++++++ .../staticControls/beads/IGraphicsDrawing.as | 11 +++ .../html/staticControls/beads/IScrollBarView.as | 63 ++++++++++++++ .../html/staticControls/beads/ITextFieldView.as | 17 ++++ .../staticControls/beads/ITextItemRenderer.as | 17 ++++ 14 files changed, 529 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSButtonView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSButtonView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSButtonView.as index f7dc60a..d5099ff 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSButtonView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSButtonView.as @@ -26,15 +26,34 @@ package org.apache.flex.html.staticControls.beads import flash.net.URLRequest; import org.apache.flex.core.IBeadView; - import org.apache.flex.core.CSSTextField; import org.apache.flex.core.IStrand; import org.apache.flex.core.ITextModel; import org.apache.flex.core.ValuesManager; - import org.apache.flex.events.Event; import org.apache.flex.utils.SolidBorderUtil; + /** + * The CSSButtonView class is the default view for + * the org.apache.flex.html.staticControls.Button class. + * It allows the look of the button to be expressed + * in CSS via the background-image style. This view + * does not display text. Use CSSTextButtonView and + * TextButton instead. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class CSSButtonView implements IBeadView { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function CSSButtonView() { upSprite = new Sprite(); @@ -48,6 +67,14 @@ package org.apache.flex.html.staticControls.beads private var shape:Shape; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSTextButtonView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSTextButtonView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSTextButtonView.as index 23428d8..b7a2721 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSTextButtonView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CSSTextButtonView.as @@ -37,8 +37,29 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.events.IEventDispatcher; import org.apache.flex.utils.SolidBorderUtil; + /** + * The CSSTextButtonView class is the default view for + * the org.apache.flex.html.staticControls.TextButton class. + * It allows the look of the button to be expressed + * in CSS via the background-image style and displays + * a text label. This view does not support right-to-left + * text. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class CSSTextButtonView implements IBeadView { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function CSSTextButtonView() { upSprite = new Sprite(); @@ -67,6 +88,14 @@ package org.apache.flex.html.staticControls.beads private var shape:Shape; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; @@ -174,10 +203,22 @@ package org.apache.flex.html.staticControls.beads private var downSprite:Sprite; private var overSprite:Sprite; + /** + * The text to be displayed in the button + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get text():String { return upTextField.text; } + + /** + * @private + */ public function set text(value:String):void { upTextField.text = value; @@ -195,11 +236,22 @@ package org.apache.flex.html.staticControls.beads } + /** + * The html-formatted text to be displayed in the button + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get html():String { return upTextField.htmlText; } + /** + * @private + */ public function set html(value:String):void { upTextField.htmlText = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CheckBoxView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CheckBoxView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CheckBoxView.as index c6a9cb3..108f74a 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CheckBoxView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/CheckBoxView.as @@ -30,8 +30,33 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.core.IToggleButtonModel; import org.apache.flex.events.Event; + /** + * The CheckBoxView class is the default view for + * the org.apache.flex.html.staticControls.CheckBox class. + * It displays a simple checkbox with an 'x' if checked, + * and a label on the right. There are no styles or + * properties to configure the look of the 'x' or the + * position of the label relative to the checkbox as + * there are no equivalents in the standard HTML checkbox. + * + * A more complex CheckBox could implement more view + * configuration. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class CheckBoxView implements IBeadView { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function CheckBoxView() { sprites = [ upSprite = new Sprite(), @@ -64,14 +89,23 @@ package org.apache.flex.html.staticControls.beads private var sprites:Array; private var _toggleButtonModel:IToggleButtonModel; - - public function get toggleButtonModel() : IToggleButtonModel + + // TODO: Can we remove this? + private function get toggleButtonModel() : IToggleButtonModel { return _toggleButtonModel; } private var _strand:IStrand; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; @@ -101,12 +135,23 @@ package org.apache.flex.html.staticControls.beads html = toggleButtonModel.html; } + /** + * @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 { var tf:CSSTextField = upSprite.getChildByName('textField') as CSSTextField; return tf.text; } + /** + * @private + */ public function set text(value:String):void { for each( var s:Sprite in sprites ) @@ -118,12 +163,23 @@ package org.apache.flex.html.staticControls.beads layoutControl(); } + /** + * @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 { var tf:CSSTextField = upSprite.getChildByName('textField') as CSSTextField; return tf.htmlText; } + /** + * @private + */ public function set html(value:String):void { for each(var s:Sprite in sprites) @@ -147,11 +203,22 @@ package org.apache.flex.html.staticControls.beads private var _selected:Boolean; + /** + * @copy org.apache.flex.core.IToggleButtonModel#selected + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get selected():Boolean { return _selected; } + /** + * @private + */ public function set selected(value:Boolean):void { _selected = value; @@ -175,6 +242,14 @@ package org.apache.flex.html.staticControls.beads selected = toggleButtonModel.selected; } + /** + * Display the icon and text label + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected function layoutControl() : void { for each(var s:Sprite in sprites) @@ -195,6 +270,14 @@ package org.apache.flex.html.staticControls.beads } + /** + * Draw the checkbox + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected function drawCheckBox(icon:Shape) : void { icon.graphics.clear(); http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ContainerView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ContainerView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ContainerView.as index ea37cf2..10b3616 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ContainerView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ContainerView.as @@ -20,29 +20,62 @@ package org.apache.flex.html.staticControls.beads { import flash.display.DisplayObject; import flash.display.DisplayObjectContainer; - import flash.display.Sprite; import org.apache.flex.core.IBead; import org.apache.flex.core.IBeadView; import org.apache.flex.core.ILayoutParent; import org.apache.flex.core.IStrand; - import org.apache.flex.core.UIBase; import org.apache.flex.core.ValuesManager; import org.apache.flex.html.staticControls.Container; import org.apache.flex.html.staticControls.supportClasses.Border; import org.apache.flex.html.staticControls.supportClasses.ContainerContentArea; import org.apache.flex.html.staticControls.supportClasses.ScrollBar; + /** + * The ContainerView class is the default view for + * the org.apache.flex.html.staticControls.Container class. + * It lets you use some CSS styles to manage the border, background + * and padding around the content area. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class ContainerView implements IBeadView, ILayoutParent { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function ContainerView() { } + /** + * The actual parent that parents the children. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected var actualParent:DisplayObjectContainer; private var _strand:IStrand; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; @@ -115,26 +148,66 @@ package org.apache.flex.html.staticControls.beads } } + /** + * The parent of the children. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get contentView():DisplayObjectContainer { return actualParent; } + /** + * The border. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get border():Border { return null; } + /** + * The host component, which can resize to different slots. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get resizableView():DisplayObject { return _strand as DisplayObject; } + /** + * The vertical ScrollBar, if it exists. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get vScrollBar():ScrollBar { return null; } + /** + * The horizontal ScrollBar, if it exists. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get hScrollBar():ScrollBar { return null; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DataItemRendererFactoryForArrayData.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DataItemRendererFactoryForArrayData.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DataItemRendererFactoryForArrayData.as index aed6c5b..7459ff1 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DataItemRendererFactoryForArrayData.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DataItemRendererFactoryForArrayData.as @@ -29,8 +29,28 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.events.Event; import org.apache.flex.events.IEventDispatcher; + /** + * The DataItemRendererFactoryForArrayData class reads an + * array of data and creates an item renderer for every + * item in the array. Other implementations of + * IDataProviderItemRendererMapper map different data + * structures or manage a virtual set of renderers. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class DataItemRendererFactoryForArrayData implements IBead, IDataProviderItemRendererMapper { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function DataItemRendererFactoryForArrayData() { } @@ -39,6 +59,14 @@ package org.apache.flex.html.staticControls.beads private var _strand:IStrand; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; @@ -56,18 +84,39 @@ package org.apache.flex.html.staticControls.beads dataProviderChangeHandler(null); } - public var _itemRendererFactory:IItemRendererClassFactory; + private var _itemRendererFactory:IItemRendererClassFactory; + /** + * The org.apache.flex.core.IItemRendererClassFactory used + * to generate instances of item renderers. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get itemRendererFactory():IItemRendererClassFactory { - return _itemRendererFactory + return _itemRendererFactory; } + /** + * @private + */ public function set itemRendererFactory(value:IItemRendererClassFactory):void { _itemRendererFactory = value; } + /** + * The org.apache.flex.core.IItemRendererParent that will + * parent the item renderers. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ protected var dataGroup:IItemRendererParent; private function dataProviderChangeHandler(event:Event):void http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DownArrowButtonView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DownArrowButtonView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DownArrowButtonView.as index 9a241f9..00cb3c4 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DownArrowButtonView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DownArrowButtonView.as @@ -25,8 +25,25 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.core.IStrand; import org.apache.flex.core.IBeadView; + /** + * The DownArrowButtonView class is the view for + * the down arrow button in a ScrollBar and other controls. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class DownArrowButtonView implements IBeadView { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function DownArrowButtonView() { upView = new Shape(); @@ -57,6 +74,14 @@ package org.apache.flex.html.staticControls.beads private var shape:Shape; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DropDownListView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DropDownListView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DropDownListView.as index 59954ed..198c206 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DropDownListView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/DropDownListView.as @@ -36,8 +36,28 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.events.Event; import org.apache.flex.events.IEventDispatcher; + /** + * The DropDownListView class is the default view for + * the org.apache.flex.html.staticControls.DropDownList class. + * It displays a simple text label with what appears to be a + * down arrow button on the right, but really, the entire + * view is the button that will display or dismiss the dropdown. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class DropDownListView implements IDropDownListView, IBeadView { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function DropDownListView() { upSprite = new Sprite(); @@ -111,6 +131,14 @@ package org.apache.flex.html.staticControls.beads private var shape:Shape; + /** + * @see org.apache.flex.core.IBead + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function set strand(value:IStrand):void { _strand = value; @@ -165,11 +193,22 @@ package org.apache.flex.html.staticControls.beads private var downArrows:Shape; private var overArrows:Shape; + /** + * The text that is displayed in the view. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get text():String { return upTextField.text; } + /** + * @private + */ public function set text(value:String):void { var ww:Number = DisplayObject(_strand).width; @@ -181,6 +220,15 @@ package org.apache.flex.html.staticControls.beads } private var _popUp:IStrand; + + /** + * The dropdown/popup that displays the set of choices. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get popUp():IStrand { return _popUp; @@ -188,11 +236,23 @@ package org.apache.flex.html.staticControls.beads private var _popUpVisible:Boolean; + /** + * A flag that indicates whether the dropdown/popup is + * visible. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get popUpVisible():Boolean { return _popUpVisible; } + /** + * @private + */ public function set popUpVisible(value:Boolean):void { if (value != _popUpVisible) http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBackgroundBead.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBackgroundBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBackgroundBead.as index f73da26..921bc8a 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBackgroundBead.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBackgroundBead.as @@ -20,6 +20,15 @@ package org.apache.flex.html.staticControls.beads { import org.apache.flex.core.IBead; + /** + * The IBackgroundBead interface is a marker interface for beads + * that draw backgrounds. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IBackgroundBead extends IBead { } http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBorderBead.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBorderBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBorderBead.as index 813be04..66115c8 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBorderBead.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IBorderBead.as @@ -20,6 +20,15 @@ package org.apache.flex.html.staticControls.beads { import org.apache.flex.core.IBead; + /** + * The IBackgroundBead interface is a marker interface for beads + * that draw backgrounds. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IBorderBead extends IBead { } http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IDropDownListView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IDropDownListView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IDropDownListView.as index b90b00c..f4ad684 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IDropDownListView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IDropDownListView.as @@ -21,10 +21,36 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.core.IBeadView; import org.apache.flex.core.IStrand; + /** + * The IDropDownListView interface is the interface for views for + * the org.apache.flex.html.staticControls.DropDownList. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IDropDownListView extends IBeadView { + + /** + * @copy org.apache.flex.html.staticControls.DropDownList#popup + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get popUp():IStrand; + /** + * @copy org.apache.flex.html.staticControls.DropDownList#popupVisible + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get popUpVisible():Boolean; function set popUpVisible(value:Boolean):void; } http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IGraphicsDrawing.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IGraphicsDrawing.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IGraphicsDrawing.as index dc1ca3d..e19f7f6 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IGraphicsDrawing.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IGraphicsDrawing.as @@ -18,6 +18,17 @@ //////////////////////////////////////////////////////////////////////////////// package org.apache.flex.html.staticControls.beads { + /** + * The IGraphicsDrawing interface is a marker interface for beads + * that draw into the graphics layer. This helps a bead determine + * if it is the first of many graphics drawing beads so it can + * know whether or not to clear the graphics layer before drawing. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IGraphicsDrawing { http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IScrollBarView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IScrollBarView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IScrollBarView.as index dbfe531..a3ecb47 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IScrollBarView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IScrollBarView.as @@ -23,14 +23,77 @@ package org.apache.flex.html.staticControls.beads import org.apache.flex.core.IScrollBarModel; import org.apache.flex.core.IStrand; + /** + * The IScrollBarView interface is the interface for views for + * the org.apache.flex.html.staticControls.supportClasses.ScrollBar. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IScrollBarView { + /** + * The down arrow button in a vertical ScrollBar or right arrow + * button in a horizontal ScrollBar + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get increment():DisplayObject; + + /** + * The up arrow button in a vertical ScrollBar or left arrow + * button in a horizontal ScrollBar + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get decrement():DisplayObject; + + /** + * The track in a ScrollBar + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get track():DisplayObject; + + /** + * The thumb in a ScrollBar + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get thumb():DisplayObject; + /** + * The data model for the view + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get scrollBarModel():IScrollBarModel; + + /** + * The ScrollBar itself. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get strand():IStrand; } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextFieldView.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextFieldView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextFieldView.as index 67fa049..f9bff0b 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextFieldView.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextFieldView.as @@ -20,8 +20,25 @@ package org.apache.flex.html.staticControls.beads { import org.apache.flex.core.CSSTextField; + /** + * The ITextFieldView interface is the interface for views for + * the use a CSSTextField to display text. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface ITextFieldView { + /** + * The org.apache.flex.core.CSSTextField used to display text. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get textField():CSSTextField; } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c74fe5ff/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextItemRenderer.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextItemRenderer.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextItemRenderer.as index e73786d..0e86593 100644 --- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextItemRenderer.as +++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ITextItemRenderer.as @@ -20,8 +20,25 @@ package org.apache.flex.html.staticControls.beads { import org.apache.flex.core.IItemRenderer; + /** + * The ITextItemRenderer interface is the interface for + * for org.apache.flex.core.IItemRenderer that display text. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface ITextItemRenderer extends IItemRenderer { + /** + * The text to be displayed in the item renderer. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get text():String; function set text(value:String):void; }
