Repository: flex-asjs Updated Branches: refs/heads/develop 689282967 -> 8de13e8d1
- Add missin doc to all models - Fix doc for MdlColor and MdlTextColor Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/8de13e8d Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/8de13e8d Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/8de13e8d Branch: refs/heads/develop Commit: 8de13e8d1b70ad07ccf90bad4f7e4aee795d7228 Parents: 6892829 Author: piotrz <[email protected]> Authored: Sat Jan 7 02:19:16 2017 +0100 Committer: piotrz <[email protected]> Committed: Sat Jan 7 02:19:16 2017 +0100 ---------------------------------------------------------------------- .../flex/org/apache/flex/mdl/beads/MdlColor.as | 14 +++++- .../org/apache/flex/mdl/beads/MdlTextColor.as | 20 +++++---- .../flex/mdl/beads/models/ISnackbarModel.as | 18 ++++++++ .../apache/flex/mdl/beads/models/ITabModel.as | 14 ++++-- .../apache/flex/mdl/beads/models/IToastModel.as | 41 ++++++++++++++++++ .../flex/mdl/beads/models/SnackbarModel.as | 35 ++++++++++++++- .../apache/flex/mdl/beads/models/TabModel.as | 17 ++++++++ .../apache/flex/mdl/beads/models/ToastModel.as | 45 +++++++++++++++++++- 8 files changed, 189 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlColor.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlColor.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlColor.as index e39856d..8833c40 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlColor.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlColor.as @@ -55,7 +55,12 @@ package org.apache.flex.mdl.beads } /** - * @inheritDoc + * @copy org.apache.flex.mdl.supportClasses.IMdlColor#color + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ public function get color():String { @@ -68,7 +73,12 @@ package org.apache.flex.mdl.beads } /** - * @inheritDoc + * @copy org.apache.flex.mdl.supportClasses.IMdlColor#colorWeight + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ public function get colorWeight():String { http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlTextColor.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlTextColor.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlTextColor.as index 58a2a91..6d6e85c 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlTextColor.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/MdlTextColor.as @@ -30,7 +30,12 @@ package org.apache.flex.mdl.beads private var _textColorWeight:String; /** - * @inheritDoc + * @copy org.apache.flex.mdl.supportClasses.IMdlTextColor#textColor + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ public function get textColor():String { @@ -43,7 +48,12 @@ package org.apache.flex.mdl.beads } /** - * @inheritDoc + * @copy org.apache.flex.mdl.supportClasses.IMdlTextColor#textColorWeight + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ public function get textColorWeight():String { @@ -79,9 +89,6 @@ package org.apache.flex.mdl.beads element.classList.toggle(elementColor, hasTextColor || hasTextColorWeight); } - /** - * @inheritDoc - */ public function get textColor():String { return _textColor; @@ -92,9 +99,6 @@ package org.apache.flex.mdl.beads _textColor = value; } - /** - * @inheritDoc - */ public function get textColorWeight():String { return _textColorWeight; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ISnackbarModel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ISnackbarModel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ISnackbarModel.as index 6236f6a..c033aaf 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ISnackbarModel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ISnackbarModel.as @@ -20,8 +20,26 @@ package org.apache.flex.mdl.beads.models { import org.apache.flex.events.IEventDispatcher; + /** + * The ISnackbarModel interface describes the minimum set of properties + * available to Snackbar type of control + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface ISnackbarModel extends IToastModel, IEventDispatcher { + + /** + * Text on action button + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get actionText():String; function set actionText(value:String):void; } http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ITabModel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ITabModel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ITabModel.as index c0110d6..452156e 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ITabModel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ITabModel.as @@ -20,13 +20,21 @@ package org.apache.flex.mdl.beads.models { import org.apache.flex.core.ISelectionModel; + /** + * The ITabModel interface describes the minimum set of properties + * available to Tabs control + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface ITabModel extends ISelectionModel { /** - * The property on the data item that the item renderer - * should renderer. + * The property on data which represents "id" of TabBarPanel * - * TabBarButton is binded with TabBarPanel. It requries unique id for each TabBarButton. + * TabBarPanel requires unique id * * @langversion 3.0 * @playerversion Flash 10.2 http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/IToastModel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/IToastModel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/IToastModel.as index cf740d2..dc15c83 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/IToastModel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/IToastModel.as @@ -20,13 +20,54 @@ package org.apache.flex.mdl.beads.models { import org.apache.flex.core.IBeadModel; + /** + * The IToastModel interface describes the minimum set of properties + * available to simple version of Snackbar - Toast + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IToastModel extends IBeadModel { + /** + * Represents main text displayed on Snackbar/Toast + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get message():String; function set message(value:String):void; + + /** + * Describe in milliseconds how long Snackbar/Toast will not disappear + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get timeout():int function set timeout(value:int):void; + /** + * Configuration object for MDL MaterialSnackbar.show method + * + * { + * message: message, + * timeout: timeout, + * actionHandler: onActionHandler, + * actionText: _actionText + * }; + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function get snackbarData():Object; } } http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/SnackbarModel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/SnackbarModel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/SnackbarModel.as index 635d9ed..51b35c0 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/SnackbarModel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/SnackbarModel.as @@ -22,6 +22,15 @@ package org.apache.flex.mdl.beads.models import org.apache.flex.core.UIBase; import org.apache.flex.events.Event; + /** + * The SnackbarModel class defines the data associated with an org.apache.flex.mdl.Snackbar + * component. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class SnackbarModel extends ToastModel implements ISnackbarModel { private var _actionText:String = ""; @@ -32,7 +41,15 @@ package org.apache.flex.mdl.beads.models { super(); } - + + /** + * @copy org.apache.flex.mdl.beads.models.ISnackbarModel#actionText + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get actionText():String { return _actionText; @@ -43,6 +60,14 @@ package org.apache.flex.mdl.beads.models _actionText = value; } + /** + * @copy org.apache.flex.mdl.beads.models.IToastModel#snackbarData + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ override public function get snackbarData():Object { return { @@ -53,6 +78,14 @@ package org.apache.flex.mdl.beads.models }; } + /** + * @copy org.apache.flex.mdl.beads.models.IToastModel#strand + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ override public function set strand(value:IStrand):void { _strand = value; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/TabModel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/TabModel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/TabModel.as index aeb2711..d4f90d5 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/TabModel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/TabModel.as @@ -20,6 +20,15 @@ package org.apache.flex.mdl.beads.models { import org.apache.flex.html.beads.models.ArraySelectionModel; + /** + * The TabModel class defines the data associated with an org.apache.flex.mdl.Tabs + * component. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class TabModel extends ArraySelectionModel implements ITabModel { public function TabModel() @@ -29,6 +38,14 @@ package org.apache.flex.mdl.beads.models private var _tabIdField:String; + /** + * @copy org.apache.flex.mdl.beads.models.ITabModel#tabIdField + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get tabIdField():String { return _tabIdField; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8de13e8d/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ToastModel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ToastModel.as b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ToastModel.as index 0af73d5..1ddadf0 100644 --- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ToastModel.as +++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/beads/models/ToastModel.as @@ -21,6 +21,15 @@ package org.apache.flex.mdl.beads.models import org.apache.flex.core.IStrand; import org.apache.flex.events.EventDispatcher; + /** + * The ToastModel class defines the data associated with an org.apache.flex.mdl.Toast + * component. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class ToastModel extends EventDispatcher implements IToastModel { private var _message:String = ""; @@ -33,6 +42,14 @@ package org.apache.flex.mdl.beads.models super(); } + /** + * @copy org.apache.flex.mdl.beads.models.IToastModel#message + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get message():String { return _message; @@ -42,7 +59,15 @@ package org.apache.flex.mdl.beads.models { _message = value; } - + /** + * @copy org.apache.flex.mdl.beads.models.IToastModel#timeout + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ + public function get timeout():int { return _timeout; @@ -53,6 +78,14 @@ package org.apache.flex.mdl.beads.models _timeout = value; } + /** + * @copy org.apache.flex.mdl.beads.models.IToastModel#snackbarData + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public function get snackbarData():Object { return { @@ -61,6 +94,16 @@ package org.apache.flex.mdl.beads.models }; } + /** + * Set strand for model + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + * + * @param value + */ public function set strand(value:IStrand):void { _strand = value;
