Polish mdl beads docs
Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/606ca702 Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/606ca702 Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/606ca702 Branch: refs/heads/feature/mdl Commit: 606ca702541347f100a5ded34ee2261c3fd9df8e Parents: 3863722 Author: Carlos Rovira <[email protected]> Authored: Sun Jan 22 20:17:03 2017 +0100 Committer: Carlos Rovira <[email protected]> Committed: Sun Jan 22 20:17:03 2017 +0100 ---------------------------------------------------------------------- .../org/apache/flex/mdl/beads/views/ListView.as | 19 +++++++- .../apache/flex/mdl/beads/views/SliderView.as | 20 +++++--- .../apache/flex/mdl/beads/views/TabBarView.as | 40 +++++++++++++++ .../apache/flex/mdl/beads/views/TableView.as | 51 +++++++++++++++++--- .../org/apache/flex/mdl/beads/views/TabsView.as | 45 ++++++++++++++++- 5 files changed, 157 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/606ca702/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/ListView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/ListView.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/ListView.as index 91eab78..f4fbb4c 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/ListView.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/ListView.as @@ -35,7 +35,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public class ListView extends BeadViewBase implements IListView { @@ -59,7 +59,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ override public function set strand(value:IStrand):void { @@ -84,6 +84,11 @@ package org.apache.flex.mdl.beads.views /** * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ protected function itemsCreatedHandler(event:Event):void { @@ -92,6 +97,11 @@ package org.apache.flex.mdl.beads.views /** * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ protected function dataProviderChangeHandler(event:Event):void { @@ -100,6 +110,11 @@ package org.apache.flex.mdl.beads.views /** * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ protected function performLayout(event:Event):void { http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/606ca702/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/SliderView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/SliderView.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/SliderView.as index 175c949..7c135ba 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/SliderView.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/SliderView.as @@ -34,13 +34,13 @@ package org.apache.flex.mdl.beads.views import org.apache.flex.html.beads.ISliderView; /** - * The SliderView class creates the visual elements of the org.apache.flex.html.Slider - * component. The Slider has a track and a thumb control which are also created with view beads. + * The SliderView class creates the visual elements of the org.apache.flex.mdl.Slider + * component. In swf the Slider has a track and a thumb control which are also created with view beads. * * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public class SliderView extends BeadViewBase implements ISliderView, IBeadView { @@ -50,7 +50,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public function SliderView() { @@ -59,14 +59,13 @@ package org.apache.flex.mdl.beads.views private var _track:Button; private var _thumb:Button; - /** * The track component. * * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public function get track():IUIBase { @@ -79,7 +78,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public function get thumb():IUIBase { @@ -94,7 +93,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ override public function set strand(value:IStrand):void { @@ -130,6 +129,11 @@ package org.apache.flex.mdl.beads.views /** * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ private function modelChangeHandler( event:Event ) : void { http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/606ca702/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabBarView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabBarView.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabBarView.as index ef9d091..a828c74 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabBarView.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabBarView.as @@ -35,11 +35,27 @@ package org.apache.flex.mdl.beads.views */ public class TabBarView extends ListView { + /** + * constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ public function TabBarView() { super(); } + /** + * @copy org.apache.flex.core.IBead#strand + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ override public function set strand(value:IStrand):void { super.strand = value; @@ -47,6 +63,14 @@ package org.apache.flex.mdl.beads.views host.addEventListener("initComplete", initCompleteHandler); } + /** + * init complete handler + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ private function initCompleteHandler(event:Event):void { host.removeEventListener("initComplete", initCompleteHandler); @@ -54,11 +78,27 @@ package org.apache.flex.mdl.beads.views completeSetup(); } + /** + * complete setup + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ protected function completeSetup():void { selectTabBarButton(); } + /** + * select tabbar button + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ private function selectTabBarButton():void { if (listModel.selectedIndex < 0 ) return; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/606ca702/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TableView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TableView.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TableView.as index e497e94..74506d5 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TableView.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TableView.as @@ -35,20 +35,44 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public class TableView extends BeadViewBase implements IListView { + /** + * constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ public function TableView() { super(); } + /** + * data group + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ public function get dataGroup():IItemRendererParent { return _strand as IItemRendererParent; } + /** + * table model + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ protected var tableModel:ISelectionModel; /** @@ -59,7 +83,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ override public function set strand(value:IStrand):void { @@ -81,9 +105,14 @@ package org.apache.flex.mdl.beads.views performLayout(null); } - + /** - * @private + * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ protected function itemsCreatedHandler(event:Event):void { @@ -91,7 +120,12 @@ package org.apache.flex.mdl.beads.views } /** - * @private + * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ protected function dataProviderChangeHandler(event:Event):void { @@ -99,7 +133,12 @@ package org.apache.flex.mdl.beads.views } /** - * @private + * @private + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 */ protected function performLayout(event:Event):void { http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/606ca702/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabsView.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabsView.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabsView.as index 4126569..549e6d5 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabsView.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/views/TabsView.as @@ -37,13 +37,20 @@ package org.apache.flex.mdl.beads.views */ public class TabsView extends ListView { + /** + * constructor. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ public function TabsView() { super(); } private var _tabBar:TabBar; - /** * The org.apache.flex.mdl.TabBar component of the * org.apache.flex.mdl.Tabs. @@ -51,7 +58,7 @@ package org.apache.flex.mdl.beads.views * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 - * @productversion FlexJS 0.0 + * @productversion FlexJS 0.8 */ public function get tabBar():TabBar { @@ -63,6 +70,16 @@ package org.apache.flex.mdl.beads.views _tabBar = value; } + /** + * @copy org.apache.flex.core.BeadViewBase#strand + * + * @param value + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ override public function set strand(value:IStrand):void { super.strand = value; @@ -78,6 +95,14 @@ package org.apache.flex.mdl.beads.views host.addEventListener("initComplete", initCompleteHandler); } + /** + * init complete handler + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ private function initCompleteHandler(event:Event):void { host.removeEventListener("initComplete", initCompleteHandler); @@ -85,6 +110,14 @@ package org.apache.flex.mdl.beads.views completeSetup(); } + /** + * complete setup + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ protected function completeSetup():void { (host as IContentViewHost).strandChildren.addElementAt(tabBar, 0); @@ -92,6 +125,14 @@ package org.apache.flex.mdl.beads.views selectTabBarPanel(); } + /** + * select tabbar panel + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.8 + */ private function selectTabBarPanel():void { if (listModel.selectedIndex < 0 ) return;
