You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by mk...@apache.org on 2013/10/16 02:13:08 UTC

git commit: [flex-sdk] [refs/heads/develop] - Correcting setButtonEnabled ASDOC comments. Better descriptions, corrected params, etc

Updated Branches:
  refs/heads/develop ba846c447 -> 90d76c623


Correcting setButtonEnabled ASDOC comments.  Better descriptions, corrected params, etc


Project: http://git-wip-us.apache.org/repos/asf/flex-sdk/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-sdk/commit/90d76c62
Tree: http://git-wip-us.apache.org/repos/asf/flex-sdk/tree/90d76c62
Diff: http://git-wip-us.apache.org/repos/asf/flex-sdk/diff/90d76c62

Branch: refs/heads/develop
Commit: 90d76c6232269a712ae8e7d436f79c7df3961324
Parents: ba846c4
Author: Mark Kessler <Ke...@gmail.com>
Authored: Tue Oct 15 20:12:07 2013 -0400
Committer: Mark Kessler <Ke...@gmail.com>
Committed: Tue Oct 15 20:12:07 2013 -0400

----------------------------------------------------------------------
 .../components/supportClasses/ButtonBarBase.as  | 24 ++++++++++++--------
 1 file changed, 15 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/90d76c62/frameworks/projects/spark/src/spark/components/supportClasses/ButtonBarBase.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/spark/src/spark/components/supportClasses/ButtonBarBase.as b/frameworks/projects/spark/src/spark/components/supportClasses/ButtonBarBase.as
index ab5a28e..cdd4841 100644
--- a/frameworks/projects/spark/src/spark/components/supportClasses/ButtonBarBase.as
+++ b/frameworks/projects/spark/src/spark/components/supportClasses/ButtonBarBase.as
@@ -550,13 +550,16 @@ public class ButtonBarBase extends ListBase
 
 
     /**
-    *  Changes the <code>enabled</code> property of a ButtonBar's Button referencing it by the ButtonBarbutton's <code>label</code>. 
+    *  Allows changing the <code>enabled</code> property of a the child ButtonBarbutton's.
+    *  It identifies the button given its label field (default) or an different optional field name may be passed. 
     *
-    *  <p>The method takes a single ButtonBarButton label, a new <code>enabled</code> property value, and an optional field name to search for.</p>
-    *  <pre>myButtonBar.setButtonEnabled("My Button Label", false)</pre>
+    *  <p>The method takes a single ButtonBarButton label, a new <code>enabled</code> property value, and an optional field name to use as the comparison field.</p>
+    *  <pre>
+    *  myButtonBar.setButtonEnabled("My Button Label", false)</pre>
     *
-    *  @param labelValue Is the ButtonBarButton label
-    *  @param fieldName Field used for comparing the label
+    *  @param labelValue Is the ButtonBarButton label.
+    *  @param enabledValue The buttons new enabled value.
+    *  @param fieldName Field used to compare the label value against.
     *
     *  @langversion 3.0
     *  @playerversion Flash 11.1
@@ -570,13 +573,16 @@ public class ButtonBarBase extends ListBase
 
 
     /**
-    *  Disables several of a ButtonBar's Buttons, referencing them by the ButtonBarbutton's <code>label</code>. 
+    *  Allows changing the <code>enabled</code> property of several child ButtonBarbutton's.
+    *  It identifies the buttons given their label fields (default) or an different optional field name may be passed. 
     *
-    *  <p>The method takes an array of ButtonBarButton labels, a new <code>enabled</code> property value, and an optional field name to search for.</p>
-    *  <pre>myButtonBar.setButtonsEnabled(["My Button Label1", "My Label2"], false)</pre>
+    *  <p>The method takes an array of ButtonBarButton labels, a new <code>enabled</code> property value, and an optional field name to use as the comparison field.</p>
+    *  <pre>
+    *  myButtonBar.setButtonsEnabled(["My Button Label1", "My Label2"], false)</pre>
     *
     *  @param labelValues Is an array of ButtonBarButton labels.
-    *  @param fieldName Field used for comparing the label
+    *  @param enabledValue The buttons new enabled value.
+    *  @param fieldName Field used to compare the label value against.
     *
     *  @langversion 3.0
     *  @playerversion Flash 11.1