flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From carlosrov...@apache.org
Subject git commit: [flex-asjs] [refs/heads/develop] - Fix mdl supporClasses docs
Date Tue, 24 Jan 2017 15:20:32 GMT
Repository: flex-asjs
Updated Branches:
  refs/heads/develop 9187f764d -> 8ca2abcec


Fix mdl supporClasses 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/8ca2abce
Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/8ca2abce
Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/8ca2abce

Branch: refs/heads/develop
Commit: 8ca2abcecd156da2f71309fdf9cd81d51248d01f
Parents: 9187f76
Author: Carlos Rovira <carlosrovira@apache.org>
Authored: Tue Jan 24 16:20:24 2017 +0100
Committer: Carlos Rovira <carlosrovira@apache.org>
Committed: Tue Jan 24 16:20:24 2017 +0100

----------------------------------------------------------------------
 .../apache/flex/mdl/supportClasses/CardInner.as | 25 ++++----------
 .../flex/mdl/supportClasses/IFooterSection.as   |  7 +++-
 .../flex/mdl/supportClasses/ITabItemRenderer.as |  8 ++---
 .../flex/mdl/supportClasses/ITextField.as       | 15 ++++-----
 .../TabBarButtonItemRendererBase.as             | 35 ++++++++++++++++----
 .../mdl/supportClasses/TabItemRendererBase.as   | 21 ++++++++----
 .../flex/mdl/supportClasses/TextFieldBase.as    | 34 +++++++++++++------
 7 files changed, 89 insertions(+), 56 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/CardInner.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/CardInner.as
b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/CardInner.as
index 48d077d..397af4f 100644
--- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/CardInner.as
+++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/CardInner.as
@@ -26,20 +26,12 @@ package org.apache.flex.mdl.supportClasses
     }
     
 	/**
-	 *  The CardInner class is a Container component capable of parenting other
-	 *  four components (CardTitle, CardMedia, CardSupportingText and CardActions. 
-     *  The Panel uses the following bead types:
-	 * 
-	 *  org.apache.flex.core.IBeadModel: the data model for the Card.
-	 *  org.apache.flex.core.IBeadView: creates the parts of the Card.
+	 *  The CardInner class is a base class por all Card inner containers.
 	 *  
-	 *  @see PanelWithControlBar
-	 *  @see ControlBar
-	 *  @see TitleBar
 	 *  @langversion 3.0
 	 *  @playerversion Flash 10.2
 	 *  @playerversion AIR 2.6
-	 *  @productversion FlexJS 0.0
+	 *  @productversion FlexJS 0.8
 	 */
 	public class CardInner extends ContainerBase
 	{
@@ -49,7 +41,7 @@ package org.apache.flex.mdl.supportClasses
 		 *  @langversion 3.0
 		 *  @playerversion Flash 10.2
 		 *  @playerversion AIR 2.6
-		 *  @productversion FlexJS 0.0
+		 *  @productversion FlexJS 0.8
 		 */
 		public function CardInner()
 		{
@@ -67,11 +59,6 @@ package org.apache.flex.mdl.supportClasses
             element = document.createElement('div') as WrappedHTMLElement;
             
             positioner = element;
-            
-            // absolute positioned children need a non-null
-            // position value in the parent.  It might
-            // get set to 'absolute' if the container is
-            // also absolutely positioned
             element.flexjs_wrapper = this;
 
             return element;
@@ -80,12 +67,12 @@ package org.apache.flex.mdl.supportClasses
 		private var _border:Boolean = false;
         /**
 		 *  A boolean flag to activate "mdl-card--border" effect selector.
-		 *  Adds a border to the card section that it's applied to
+		 *  Adds a border to the card section that it's applied to.
 		 *
 		 *  @langversion 3.0
 		 *  @playerversion Flash 10.2
 		 *  @playerversion AIR 2.6
-		 *  @productversion FlexJS 0.0
+		 *  @productversion FlexJS 0.8
 		 */
         public function get border():Boolean
         {
@@ -110,7 +97,7 @@ package org.apache.flex.mdl.supportClasses
 		 *  @langversion 3.0
 		 *  @playerversion Flash 10.2
 		 *  @playerversion AIR 2.6
-		 *  @productversion FlexJS 0.0
+		 *  @productversion FlexJS 0.8
 		 */
         public function get expand():Boolean
         {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/IFooterSection.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/IFooterSection.as
b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/IFooterSection.as
index 6298545..e7a9c15 100644
--- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/IFooterSection.as
+++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/IFooterSection.as
@@ -19,7 +19,12 @@
 package org.apache.flex.mdl.supportClasses
 {
     /**
-     * marker interface
+     *  Marker interface for all footer sections
+     *
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.8
      */
     public interface IFooterSection
     {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/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 cae7b1f..5473746 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
@@ -26,7 +26,7 @@ package org.apache.flex.mdl.supportClasses
      *  @langversion 3.0
      *  @playerversion Flash 10.2
      *  @playerversion AIR 2.6
-     *  @productversion FlexJS 0.0
+     *  @productversion FlexJS 0.8
      */
     public interface ITabItemRenderer extends ISelectableItemRenderer
     {
@@ -36,18 +36,18 @@ package org.apache.flex.mdl.supportClasses
          *  @langversion 3.0
          *  @playerversion Flash 10.2
          *  @playerversion AIR 2.6
-         *  @productversion FlexJS 0.0
+         *  @productversion FlexJS 0.8
          */
         function get tabIdField():String;
         function set tabIdField(value:String):void;
 
         /**
-         * Indicates whether specific Tab is currently selected/active
+         *  Indicates whether specific Tab is currently selected/active
          * 
          *  @langversion 3.0
          *  @playerversion Flash 10.2
          *  @playerversion AIR 2.6
-         *  @productversion FlexJS 0.0
+         *  @productversion FlexJS 0.8
          */
         function get isActive():Boolean;
         function set isActive(value:Boolean):void;

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITextField.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITextField.as
b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITextField.as
index d2adbf7..c7f07b7 100644
--- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITextField.as
+++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/ITextField.as
@@ -19,16 +19,13 @@
 package org.apache.flex.mdl.supportClasses
 {
     /**
-     *  The IMdlColor interface must be implemented by any class that
-     *  will apply color and colorWeight provided by google style color.
-     *
-     *  https://material.google.com/style/color.html#color-color-palette
-     *  https://gitlab.com/material/colors/blob/master/colors.html
+     *  ITextField is the interface that all TextField MDL classes implement
+     *  It's used mainly in org.apache.flex.mdl.supportClasses.TextFieldBase
      *
      *  @langversion 3.0
      *  @playerversion Flash 10.2
      *  @playerversion AIR 2.6
-     *  @productversion FlexJS 0.0
+     *  @productversion FlexJS 0.8
      */
     public interface ITextField
     {
@@ -40,7 +37,7 @@ package org.apache.flex.mdl.supportClasses
             * @langversion 3.0
             * @playerversion Flash 10.2
             * @playerversion AIR 2.6
-            * @productversion FlexJS 0.0
+            * @productversion FlexJS 0.8
             */
             function get textNode():Text;
             function set textNode(value:Text):void;
@@ -51,7 +48,7 @@ package org.apache.flex.mdl.supportClasses
             * @langversion 3.0
             * @playerversion Flash 10.2
             * @playerversion AIR 2.6
-            * @productversion FlexJS 0.0
+            * @productversion FlexJS 0.8
             */
             function get input():HTMLInputElement;
             function set input(value:HTMLInputElement):void;
@@ -62,7 +59,7 @@ package org.apache.flex.mdl.supportClasses
             * @langversion 3.0
             * @playerversion Flash 10.2
             * @playerversion AIR 2.6
-            * @productversion FlexJS 0.0
+            * @productversion FlexJS 0.8
             */
             function get label():HTMLLabelElement;
             function set label(value:HTMLLabelElement):void;

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/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 ce08b2d..c980bd2 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
@@ -31,10 +31,18 @@ package org.apache.flex.mdl.supportClasses
      *  @langversion 3.0
      *  @playerversion Flash 10.2
      *  @playerversion AIR 2.6
-     *  @productversion FlexJS 0.0
-     * */
+     *  @productversion FlexJS 0.8
+     */
     public class TabBarButtonItemRendererBase extends MXMLItemRenderer implements ITabItemRenderer
     {
+        /**
+		 *  constructor.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.8
+		 */
         public function TabBarButtonItemRendererBase()
         {
             super();
@@ -43,18 +51,32 @@ package org.apache.flex.mdl.supportClasses
         }
 
         private var _tabIdField:String;
-        private var _isActive:Boolean;
-        
+        /**
+		 *  tabIdField.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.8
+		 */
         public function get tabIdField():String
         {
             return _tabIdField;
         }
-
         public function set tabIdField(value:String):void
         {
             _tabIdField = value;
         }
         
+        private var _isActive:Boolean;
+        /**
+		 *  isActive.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.8
+		 */
         public function get isActive():Boolean
         {
             return _isActive;
@@ -78,7 +100,7 @@ package org.apache.flex.mdl.supportClasses
          *  @langversion 3.0
          *  @playerversion Flash 10.2
          *  @playerversion AIR 2.6
-         *  @productversion FlexJS 0.0
+         *  @productversion FlexJS 0.8
          */
         override public function set data(value:Object):void
         {
@@ -100,6 +122,7 @@ package org.apache.flex.mdl.supportClasses
         
         /**
          * @flexjsignorecoercion org.apache.flex.core.WrappedHTMLElement
+         * @flexjsignorecoercion HTMLAnchorElement
          */
         COMPILE::JS
         override protected function createElement():WrappedHTMLElement

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/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 c159f3f..a56083f 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
@@ -26,10 +26,18 @@ package org.apache.flex.mdl.supportClasses
      *  @langversion 3.0
      *  @playerversion Flash 10.2
      *  @playerversion AIR 2.6
-     *  @productversion FlexJS 0.0
-     * */
+     *  @productversion FlexJS 0.8
+     */
     public class TabItemRendererBase extends MXMLItemRenderer implements ITabItemRenderer
     {
+        /**
+		 *  constructor.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.8
+		 */
         public function TabItemRendererBase()
         {
             super();
@@ -38,15 +46,13 @@ 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
+         *  @productversion FlexJS 0.8
          */
         public function get tabIdField():String
         {
@@ -58,13 +64,14 @@ package org.apache.flex.mdl.supportClasses
             _tabIdField = value;
         }
 
+        private var _isActive:Boolean;
         /**
          *  @copy org.apache.flex.mdl.supportClasses.ITabItemRenderer#isActive
          *
          *  @langversion 3.0
          *  @playerversion Flash 10.2
          *  @playerversion AIR 2.6
-         *  @productversion FlexJS 0.0
+         *  @productversion FlexJS 0.8
          */
         public function get isActive():Boolean
         {
@@ -89,7 +96,7 @@ package org.apache.flex.mdl.supportClasses
          *  @langversion 3.0
          *  @playerversion Flash 10.2
          *  @playerversion AIR 2.6
-         *  @productversion FlexJS 0.0
+         *  @productversion FlexJS 0.8
          */
         override public function set data(value:Object):void
         {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/8ca2abce/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TextFieldBase.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TextFieldBase.as
b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TextFieldBase.as
index bcae565..9a56dcb 100644
--- a/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TextFieldBase.as
+++ b/frameworks/projects/MaterialDesignLite/src/main/flex/org/apache/flex/mdl/supportClasses/TextFieldBase.as
@@ -34,7 +34,7 @@ package org.apache.flex.mdl.supportClasses
      *  @langversion 3.0
      *  @playerversion Flash 10.2
      *  @playerversion AIR 2.6
-     *  @productversion FlexJS 0.0
+     *  @productversion FlexJS 0.8
      */    
 	public class TextFieldBase extends TextInput implements ITextField
 	{
@@ -44,7 +44,7 @@ package org.apache.flex.mdl.supportClasses
          *  @langversion 3.0
          *  @playerversion Flash 10.2
          *  @playerversion AIR 2.6
-         *  @productversion FlexJS 0.0
+         *  @productversion FlexJS 0.8
          */
 		public function TextFieldBase()
 		{
@@ -56,14 +56,13 @@ package org.apache.flex.mdl.supportClasses
         COMPILE::JS
         {
             private var _textNode:Text;
-
             /**
              *  @copy org.apache.flex.mdl.supportClasses.ITextField#textNode
              *
              *  @langversion 3.0
              *  @playerversion Flash 10.2
              *  @playerversion AIR 2.6
-             *  @productversion FlexJS 0.0
+             *  @productversion FlexJS 0.8
              */
             public function get textNode():Text
             {
@@ -76,14 +75,13 @@ package org.apache.flex.mdl.supportClasses
             }
 
             private var _input:HTMLInputElement;
-
             /**
              *  @copy org.apache.flex.mdl.supportClasses.ITextField#input
              *
              *  @langversion 3.0
              *  @playerversion Flash 10.2
              *  @playerversion AIR 2.6
-             *  @productversion FlexJS 0.0
+             *  @productversion FlexJS 0.8
              */
             public function get input():HTMLInputElement
             {
@@ -96,7 +94,14 @@ package org.apache.flex.mdl.supportClasses
             }
 
             private var _label:HTMLLabelElement;
-
+            /**
+             *  @copy org.apache.flex.mdl.supportClasses.ITextField#label
+             *
+             *  @langversion 3.0
+             *  @playerversion Flash 10.2
+             *  @playerversion AIR 2.6
+             *  @productversion FlexJS 0.8
+             */
             public function get label():HTMLLabelElement
             {
                 return _label;
@@ -109,6 +114,14 @@ package org.apache.flex.mdl.supportClasses
         }
 
         COMPILE::JS
+        /**
+		 *  override UIBase to affect positioner instead of element
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.8
+		 */
 		override protected function setClassName(value:String):void
 		{
 			positioner.className = value;           
@@ -122,7 +135,7 @@ package org.apache.flex.mdl.supportClasses
 		 *  @langversion 3.0
 		 *  @playerversion Flash 10.2
 		 *  @playerversion AIR 2.6
-		 *  @productversion FlexJS 0.0
+		 *  @productversion FlexJS 0.8
 		 */
         public function get floatingLabel():Boolean
         {
@@ -142,12 +155,13 @@ package org.apache.flex.mdl.supportClasses
         private var _isInvalid:Boolean = false;
         /**
 		 *  A boolean flag to activate "is-invalid" effect selector.
-         *  Defines the textfield as invalid on initial load.Optional
+         *  Defines the textfield as invalid on initial load.
+         *  Optional
 		 *
 		 *  @langversion 3.0
 		 *  @playerversion Flash 10.2
 		 *  @playerversion AIR 2.6
-		 *  @productversion FlexJS 0.0
+		 *  @productversion FlexJS 0.8
 		 */
         public function get isInvalid():Boolean
         {


Mime
View raw message