Add missing doc for MDL Tabs item renderers
Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/6dc77471 Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/6dc77471 Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/6dc77471 Branch: refs/heads/feature/fontawesome Commit: 6dc77471e5d24fb90cf3e6e43f91680f7f1e4b91 Parents: da83830 Author: piotrz <pio...@apache.org> Authored: Sat Jan 7 13:10:33 2017 +0100 Committer: piotrz <pio...@apache.org> Committed: Sat Jan 7 13:10:33 2017 +0100 ---------------------------------------------------------------------- .../flex/org/apache/flex/mdl/TabBarPanel.as | 1 + .../TabsItemRendererFactoryForArrayData.as | 10 ++++++++ .../TabBarButtonLayoutItemRenderer.as | 12 +++++++++ .../TabBarButtonTabsItemRenderer.as | 11 +++++++++ .../itemRenderers/TabBarLayoutItemRenderer.as | 10 ++++++++ .../itemRenderers/TabBarPanelItemRenderer.as | 10 ++++++++ .../flex/mdl/supportClasses/ITabItemRenderer.as | 26 +++++++++++++++++++- .../TabBarButtonItemRendererBase.as | 8 ++++++ .../mdl/supportClasses/TabItemRendererBase.as | 26 +++++++++++++++++++- 9 files changed, 112 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/TabBarPanel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/TabBarPanel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/TabBarPanel.as index 9141eaf..98db21e 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/TabBarPanel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/TabBarPanel.as @@ -97,6 +97,7 @@ package org.apache.flex.mdl } private var _isActive:Boolean; + /** * Marks this Button as the active one in the TabBar * http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/TabsItemRendererFactoryForArrayData.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/TabsItemRendererFactoryForArrayData.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/TabsItemRendererFactoryForArrayData.as index b898f17..f24674d 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/TabsItemRendererFactoryForArrayData.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/TabsItemRendererFactoryForArrayData.as @@ -37,6 +37,16 @@ package org.apache.flex.mdl.beads [Event(name="itemRendererCreated",type="org.apache.flex.events.ItemRendererEvent")] + /** + * The TabsItemRendererFactoryForArrayData class reads an + * array of data and creates an item renderer for every + * ITabItemRenderer in the array. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class TabsItemRendererFactoryForArrayData extends EventDispatcher implements IBead, IDataProviderItemRendererMapper { public function TabsItemRendererFactoryForArrayData(target:Object = null) http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonLayoutItemRenderer.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonLayoutItemRenderer.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonLayoutItemRenderer.as index bea06e8..35ff154 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonLayoutItemRenderer.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonLayoutItemRenderer.as @@ -25,6 +25,18 @@ package org.apache.flex.mdl.itemRenderers import org.apache.flex.core.WrappedHTMLElement; } + /** + * Represents item renderer for TabBarButton + * + * Layout type item renderer + * + * Creates MDL "mdl-layout__tab" conponent + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * */ public class TabBarButtonLayoutItemRenderer extends TabBarButtonItemRendererBase { public function TabBarButtonLayoutItemRenderer() http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonTabsItemRenderer.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonTabsItemRenderer.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonTabsItemRenderer.as index 0eedc3a..4962f54 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonTabsItemRenderer.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarButtonTabsItemRenderer.as @@ -25,6 +25,17 @@ package org.apache.flex.mdl.itemRenderers import org.apache.flex.core.WrappedHTMLElement; } + /** + * Represents item renderer for TabBarButton + * + * It is default item renderer for TabBarButton + * Creates MDL "mdl-tabs__tab" conponent + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * */ public class TabBarButtonTabsItemRenderer extends TabBarButtonItemRendererBase { public function TabBarButtonTabsItemRenderer() http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarLayoutItemRenderer.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarLayoutItemRenderer.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarLayoutItemRenderer.as index 51e7888..16ac65c 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarLayoutItemRenderer.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarLayoutItemRenderer.as @@ -25,6 +25,16 @@ package org.apache.flex.mdl.itemRenderers import org.apache.flex.core.WrappedHTMLElement; } + /** + * Layout type content for Tabs + * + * Creates MDL "mdl-layout__tab-panel" conponent + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * */ public class TabBarLayoutItemRenderer extends TabItemRendererBase { public function TabBarLayoutItemRenderer() http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarPanelItemRenderer.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarPanelItemRenderer.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarPanelItemRenderer.as index 55c3ed1..f2711d0 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarPanelItemRenderer.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/itemRenderers/TabBarPanelItemRenderer.as @@ -25,6 +25,16 @@ package org.apache.flex.mdl.itemRenderers import org.apache.flex.core.WrappedHTMLElement; } + /** + * Represents content of TabBarPanel + * + * Creates MDL "mdl-tabs__panel" conponent + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * */ public class TabBarPanelItemRenderer extends TabItemRendererBase { public function TabBarPanelItemRenderer() http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITabItemRenderer.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITabItemRenderer.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITabItemRenderer.as index a552908..cae7b1f 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITabItemRenderer.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITabItemRenderer.as @@ -20,11 +20,35 @@ package org.apache.flex.mdl.supportClasses { import org.apache.flex.core.ISelectableItemRenderer; + /** + * The ITabItemRenderer interface is the basic interface for MDL Tabs and TabBar item renderers. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface ITabItemRenderer extends ISelectableItemRenderer { + /** + * Provides name of the property which stores "id" for Tab + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get tabIdField():String; function set tabIdField(value:String):void; - + + /** + * Indicates whether specific Tab is currently selected/active + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get isActive():Boolean; function set isActive(value:Boolean):void; } http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabBarButtonItemRendererBase.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabBarButtonItemRendererBase.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabBarButtonItemRendererBase.as index 14d5f6d..ce08b2d 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabBarButtonItemRendererBase.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabBarButtonItemRendererBase.as @@ -25,6 +25,14 @@ package org.apache.flex.mdl.supportClasses import org.apache.flex.core.WrappedHTMLElement; } + /** + * Base class for TabBarButton item renderers + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * */ public class TabBarButtonItemRendererBase extends MXMLItemRenderer implements ITabItemRenderer { public function TabBarButtonItemRendererBase() http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/6dc77471/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabItemRendererBase.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabItemRendererBase.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabItemRendererBase.as index 03eaba4..c159f3f 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabItemRendererBase.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TabItemRendererBase.as @@ -19,7 +19,15 @@ package org.apache.flex.mdl.supportClasses { import org.apache.flex.html.supportClasses.MXMLItemRenderer; - + + /** + * Base class for Tabs item renderers + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * */ public class TabItemRendererBase extends MXMLItemRenderer implements ITabItemRenderer { public function TabItemRendererBase() @@ -32,6 +40,14 @@ package org.apache.flex.mdl.supportClasses private var _tabIdField:String; private var _isActive:Boolean; + /** + * @copy org.apache.flex.mdl.supportClasses.ITabItemRenderer#tabIdField + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get tabIdField():String { return _tabIdField; @@ -42,6 +58,14 @@ package org.apache.flex.mdl.supportClasses _tabIdField = value; } + /** + * @copy org.apache.flex.mdl.supportClasses.ITabItemRenderer#isActive + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get isActive():Boolean { return _isActive;
