Updated Branches:
refs/heads/develop 6cd5ef3d0 -> 11f443add
More asdoc additions.
Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/11f443ad
Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/11f443ad
Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/11f443ad
Branch: refs/heads/develop
Commit: 11f443addfd3eb45b23fe3d0cc1fcc4cd0c78a11
Parents: 6cd5ef3
Author: Peter Ent <pent@apache.org>
Authored: Tue Feb 4 13:41:04 2014 -0500
Committer: Peter Ent <pent@apache.org>
Committed: Tue Feb 4 13:41:04 2014 -0500
----------------------------------------------------------------------
.../flex/html/staticControls/SimpleList.as | 2 +-
.../accessories/NumericOnlyTextInputBead.as | 36 +++++++++
.../accessories/PasswordInputBead.as | 24 ++++++
.../accessories/TextPromptBead.as | 34 +++++++++
.../beads/AlertMeasurementBead.as | 37 +++++++++
.../flex/html/staticControls/beads/AlertView.as | 40 ++++++++++
.../html/staticControls/beads/ButtonBarView.as | 28 +++++++
.../html/staticControls/beads/ComboBoxView.as | 69 ++++++++++++++++-
.../beads/ControlBarMeasurementBead.as | 37 +++++++++
.../html/staticControls/beads/IComboBoxView.as | 41 ++++++++++
.../flex/html/staticControls/beads/IListView.as | 27 +++++++
.../html/staticControls/beads/ISliderView.as | 26 +++++++
.../html/staticControls/beads/ISpinnerView.as | 26 +++++++
.../flex/html/staticControls/beads/ImageView.as | 28 +++++++
.../flex/html/staticControls/beads/ListView.as | 79 ++++++++++++++++++--
.../staticControls/beads/NumericStepperView.as | 53 +++++++++++++
.../flex/html/staticControls/beads/PanelView.as | 41 ++++++++++
.../staticControls/beads/RadioButtonView.as | 64 +++++++++++++++-
.../staticControls/beads/SimpleAlertView.as | 26 +++++++
.../staticControls/beads/SliderThumbView.as | 26 +++++++
.../staticControls/beads/SliderTrackView.as | 26 +++++++
.../html/staticControls/beads/SliderView.as | 46 ++++++++++++
.../html/staticControls/beads/SpinnerView.as | 40 ++++++++++
.../beads/TextButtonMeasurementBead.as | 31 ++++++++
.../beads/TextFieldLabelMeasurementBead.as | 36 +++++++++
.../beads/TitleBarMeasurementBead.as | 36 +++++++++
26 files changed, 945 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/SimpleList.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/SimpleList.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/SimpleList.as
index 951ab46..4e2dba6 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/SimpleList.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/SimpleList.as
@@ -21,7 +21,7 @@ package org.apache.flex.html.staticControls
/**
* The SimpleList class is a component that displays data in a vertical column. This
* component differs from List in that it displays only string values and converts to
- * the <select> HTML element.
+ * the <select> HTML element.
*
* @langversion 3.0
* @playerversion Flash 10.2
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.as
index b92a317..98a83f6 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.as
@@ -27,14 +27,35 @@ package org.apache.flex.html.staticControls.accessories
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.beads.ITextFieldView;
+ /**
+ * The NumericOnlyTextInputBead class is a specialty bead that can be used with
+ * any TextInput control. The bead prevents non-numeric entry into the text input
+ * area.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class NumericOnlyTextInputBead implements IBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function NumericOnlyTextInputBead()
{
}
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -43,6 +64,15 @@ package org.apache.flex.html.staticControls.accessories
}
private var _decimalSeparator:String = ".";
+
+ /**
+ * The character used to separate the integer and fraction parts of numbers.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get decimalSeparator():String
{
return _decimalSeparator;
@@ -54,6 +84,9 @@ package org.apache.flex.html.staticControls.accessories
}
}
+ /**
+ * @private
+ */
private function viewChangeHandler(event:Event):void
{
// get the ITextFieldView bead, which is required for this bead to work
@@ -71,6 +104,9 @@ package org.apache.flex.html.staticControls.accessories
}
}
+ /**
+ * @private
+ */
private function handleTextInput(event:TextEvent):void
{
var insert:String = event.text;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/PasswordInputBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/PasswordInputBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/PasswordInputBead.as
index 9280317..77eea4d 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/PasswordInputBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/PasswordInputBead.as
@@ -25,14 +25,35 @@ package org.apache.flex.html.staticControls.accessories
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.beads.ITextFieldView;
+ /**
+ * The PasswordInput class is a specialty bead that can be used with
+ * any TextInput control. The bead secures the text input area by masking
+ * the input as it is typed.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class PasswordInputBead implements IBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function PasswordInputBead()
{
}
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -40,6 +61,9 @@ package org.apache.flex.html.staticControls.accessories
IEventDispatcher(value).addEventListener("viewChanged",viewChangeHandler);
}
+ /**
+ * @private
+ */
private function viewChangeHandler(event:Event):void
{
// get the ITextFieldView bead, which is required for this bead to work
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/TextPromptBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/TextPromptBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/TextPromptBead.as
index d27dafa..ed9775e 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/TextPromptBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/accessories/TextPromptBead.as
@@ -27,13 +27,40 @@ package org.apache.flex.html.staticControls.accessories
import org.apache.flex.events.Event;
import org.apache.flex.events.IEventDispatcher;
+ /**
+ * The TextPromptBead class is a specialty bead that can be used with
+ * any TextInput control. The bead places a string into the input field
+ * when there is no value associated with the text property.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class TextPromptBead implements IBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function TextPromptBead()
{
}
private var _prompt:String;
+
+ /**
+ * The string to use as the placeholder prompt.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get prompt():String
{
return _prompt;
@@ -44,6 +71,10 @@ package org.apache.flex.html.staticControls.accessories
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -72,6 +103,9 @@ package org.apache.flex.html.staticControls.accessories
private var promptField:CSSTextField;
private var promptAdded:Boolean;
+ /**
+ * @private
+ */
private function handleTextChange( event:Event ):void
{
// see what the model currently has to determine if the prompt should be
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertMeasurementBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertMeasurementBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertMeasurementBead.as
index 8199b28..a498ea8 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertMeasurementBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertMeasurementBead.as
@@ -21,23 +21,60 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IMeasurementBead;
import org.apache.flex.core.IStrand;
+ /**
+ * The AlertMeasureBead class provides boundary measurements for an Alert
+ * component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class AlertMeasurementBead implements IMeasurementBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function AlertMeasurementBead()
{
}
+ /**
+ * Returns the overall width of the Alert component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredWidth():Number
{
return 0;
}
+ /**
+ * Returns the overall height of the Alert component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredHeight():Number
{
return 0;
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertView.as
index b02911a..3a4e06a 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/AlertView.as
@@ -36,8 +36,26 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.TitleBar;
import org.apache.flex.utils.BeadMetrics;
+ /**
+ * The AlertView class creates the visual elements of the Alert component. The job of
+ * the view bead is to put together the parts of the Alert, such as the TitleBar, message,
+ * and various buttons, within the space of the Alert component strand.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class AlertView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function AlertView()
{
}
@@ -51,6 +69,10 @@ package org.apache.flex.html.staticControls.beads
private var _noButton:TextButton;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -120,6 +142,9 @@ package org.apache.flex.html.staticControls.beads
sizeHandler(null);
}
+ /**
+ * @private
+ */
private function sizeHandler(event:Event):void
{
var labelMeasure:IMeasurementBead = _label.measurementBead;
@@ -146,6 +171,9 @@ package org.apache.flex.html.staticControls.beads
UIBase(_strand).height = _controlBar.y + _controlBar.height + metrics.bottom + 2;
}
+ /**
+ * @private
+ */
private function handleOK(event:Event):void
{
// create some custom event where the detail value
@@ -153,21 +181,33 @@ package org.apache.flex.html.staticControls.beads
dispatchCloseEvent(Alert.OK);
}
+ /**
+ * @private
+ */
private function handleCancel(event:Event):void
{
dispatchCloseEvent(Alert.CANCEL);
}
+ /**
+ * @private
+ */
private function handleYes(event:Event):void
{
dispatchCloseEvent(Alert.YES);
}
+ /**
+ * @private
+ */
private function handleNo(event:Event):void
{
dispatchCloseEvent(Alert.NO);
}
+ /**
+ * @private
+ */
public function dispatchCloseEvent(buttonFlag:uint):void
{
// TO DO: buttonFlag should be part of the event
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ButtonBarView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ButtonBarView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ButtonBarView.as
index d9f0fd3..9ee35c2 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ButtonBarView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ButtonBarView.as
@@ -31,8 +31,25 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.supportClasses.Border;
+ /**
+ * The ButtonBarView class creates the visual elements of the ButtonBar component. A ButtonBar is a
+ * type of List and ButtonBarView extends the ListView bead, adding a border.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ButtonBarView extends ListView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ButtonBarView()
{
super();
@@ -40,6 +57,14 @@ package org.apache.flex.html.staticControls.beads
private var _border:Border;
+ /**
+ * The ButtonBar's border.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
override public function get border():Border
{
return _border;
@@ -47,6 +72,9 @@ package org.apache.flex.html.staticControls.beads
private var _strand:IStrand;
+ /**
+ * @private
+ */
override public function set strand(value:IStrand):void
{
_strand = value;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ComboBoxView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ComboBoxView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ComboBoxView.as
index d7a5bba..3aad763 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ComboBoxView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ComboBoxView.as
@@ -33,15 +33,42 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.Button;
import org.apache.flex.html.staticControls.TextInput;
+ /**
+ * The ComboBoxView class creates the visual elements of the ComboBox component. The job of
+ * the view bead is to put together the parts of the ComboBox such as the TextInput
+ * control and Button to trigger the pop-up.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ComboBoxView implements IBeadView, IComboBoxView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ComboBoxView()
{
}
private var textInput:TextInput;
private var button:Button;
+ private var selectionModel:IComboBoxModel;
+ /**
+ * The value of the TextInput component of the ComboBox.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get text():String
{
return textInput.text;
@@ -51,6 +78,14 @@ package org.apache.flex.html.staticControls.beads
textInput.text = value;
}
+ /**
+ * The HTML value of the TextInput component of the ComboBox.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get html():String
{
return textInput.html;
@@ -59,15 +94,16 @@ package org.apache.flex.html.staticControls.beads
{
textInput.html = value;
}
+
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function get strand():IStrand
{
return _strand;
}
-
- private var selectionModel:IComboBoxModel;
-
public function set strand(value:IStrand):void
{
_strand = value;
@@ -102,6 +138,9 @@ package org.apache.flex.html.staticControls.beads
private var overSprite:Sprite;
private var downSprite:Sprite;
+ /**
+ * @private
+ */
private function drawButton( sprite:Sprite, mode:String, width:Number, height:Number ) : void
{
sprite.graphics.clear();
@@ -123,6 +162,15 @@ package org.apache.flex.html.staticControls.beads
}
private var _popUp:IStrand;
+
+ /**
+ * The pop-up component that holds the selection list.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get popUp():IStrand
{
return _popUp;
@@ -130,11 +178,18 @@ package org.apache.flex.html.staticControls.beads
private var _popUpVisible:Boolean;
+ /**
+ * This property is true if the pop-up selection list is currently visible.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get popUpVisible():Boolean
{
return _popUpVisible;
}
-
public function set popUpVisible(value:Boolean):void
{
if (value != _popUpVisible)
@@ -161,11 +216,17 @@ package org.apache.flex.html.staticControls.beads
}
}
+ /**
+ * @private
+ */
private function selectionChangeHandler(event:Event):void
{
text = selectionModel.selectedItem.toString();
}
+ /**
+ * @private
+ */
private function textChangeHandler(event:Event):void
{
var newEvent:Event = new Event("change");
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ControlBarMeasurementBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ControlBarMeasurementBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ControlBarMeasurementBead.as
index af16940..b74d6cc 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ControlBarMeasurementBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ControlBarMeasurementBead.as
@@ -25,12 +25,37 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IUIBase;
import org.apache.flex.html.staticControls.Container;
+ /**
+ * The ControlBarMeasurementBead class measures the size of a ControlBar
+ * component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ControlBarMeasurementBead implements IMeasurementBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ControlBarMeasurementBead()
{
}
+ /**
+ * Returns the overall width of the ControlBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredWidth():Number
{
// Note: the measurement should problably be done by the ControlBar's layout manager bead
@@ -49,6 +74,14 @@ package org.apache.flex.html.staticControls.beads
return mwidth;
}
+ /**
+ * Returns the overall height of the ControlBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredHeight():Number
{
// Note: the measurement should problably be done by the ControlBar's layout manager bead
@@ -66,6 +99,10 @@ package org.apache.flex.html.staticControls.beads
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IComboBoxView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IComboBoxView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IComboBoxView.as
index e3866fc..dbbed93 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IComboBoxView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IComboBoxView.as
@@ -21,16 +21,57 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IBeadView;
import org.apache.flex.core.IStrand;
+ /**
+ * The IComboBoxView interface provides the protocol for any bead that
+ * creates the visual parts for a ComboBox control.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public interface IComboBoxView extends IBeadView
{
+ /**
+ * The string appearing in the input area for the ComboBox.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get text():String;
function set text(value:String):void;
+ /**
+ * The HTML string appearing in the input area for the ComboBox.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get html():String;
function set html(value:String):void;
+ /**
+ * The component housing the selection list.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get popUp():IStrand;
+ /**
+ * Determines whether or not the pop-up with the selection list is visible or not.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get popUpVisible():Boolean;
function set popUpVisible(value:Boolean):void;
}
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IListView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IListView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IListView.as
index 590dad0..0bfae97 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IListView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/IListView.as
@@ -21,9 +21,36 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IItemRendererParent;
import org.apache.flex.core.IStrand;
+ /**
+ * The IListView interface provides the protocol for any bead that
+ * creates the visual parts for a List control.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public interface IListView
{
+ /**
+ * The component which parents all of the itemRenderers for each
+ * datum being displayed by the List component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get dataGroup():IItemRendererParent;
+
+ /**
+ * The host component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get strand():IStrand;
}
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISliderView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISliderView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISliderView.as
index aa0db41..bf7e83d 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISliderView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISliderView.as
@@ -22,9 +22,35 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IBead;
+ /**
+ * The ISliderView interface provides the protocol for any bead that
+ * creates the visual parts for a Slider control.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public interface ISliderView extends IBead
{
+ /**
+ * The component used for the track area of the Slider.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get track():DisplayObject;
+
+ /**
+ * The component used for the thumb button of the Slider.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get thumb():DisplayObject;
}
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISpinnerView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISpinnerView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISpinnerView.as
index 920024c..1c37923 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISpinnerView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ISpinnerView.as
@@ -22,9 +22,35 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IBead;
+ /**
+ * The ISpinnerView interface provides the protocol for any bead that
+ * creates the visual parts for a Spinner control.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public interface ISpinnerView extends IBead
{
+ /**
+ * The component used to increment the Spinner value.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get increment():DisplayObject;
+
+ /**
+ * The component used to decrement the Spinner value.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
function get decrement():DisplayObject;
}
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ImageView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ImageView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ImageView.as
index 1171e15..e1e79b8 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ImageView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ImageView.as
@@ -30,8 +30,24 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.events.Event;
import org.apache.flex.events.IEventDispatcher;
+ /**
+ * The ImageView class creates the visual elements of the Image component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ImageView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ImageView()
{
}
@@ -42,6 +58,9 @@ package org.apache.flex.html.staticControls.beads
private var _strand:IStrand;
private var _model:IImageModel;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -55,6 +74,9 @@ package org.apache.flex.html.staticControls.beads
handleUrlChange(null);
}
+ /**
+ * @private
+ */
private function handleUrlChange(event:Event):void
{
if (_model.source) {
@@ -64,6 +86,9 @@ package org.apache.flex.html.staticControls.beads
}
}
+ /**
+ * @private
+ */
private function onComplete(event:Object):void
{
if (bitmap) {
@@ -77,6 +102,9 @@ package org.apache.flex.html.staticControls.beads
handleSizeChange(null);
}
+ /**
+ * @private
+ */
private function handleSizeChange(event:Object):void
{
if (bitmap) {
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ListView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ListView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ListView.as
index f90994e..0c6ff96 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ListView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/ListView.as
@@ -43,6 +43,15 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.supportClasses.NonVirtualDataGroup;
import org.apache.flex.html.staticControls.supportClasses.ScrollBar;
+ /**
+ * The List class creates the visual elements of the List component. A List consists of
+ * the area to display the data (in the dataGroup), any scrollbars, and so forth.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ListView extends Strand implements IBeadView, IStrand, IListView, ILayoutParent
{
public function ListView()
@@ -51,15 +60,31 @@ package org.apache.flex.html.staticControls.beads
private var listModel:ISelectionModel;
- private var _border:Border;
-
+ private var _border:Border;
+
+ /**
+ * The border surrounding the List.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get border():Border
{
return _border;
}
-
- private var _dataGroup:IItemRendererParent;
-
+
+ private var _dataGroup:IItemRendererParent;
+
+ /**
+ * The area holding the itemRenderers.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get dataGroup():IItemRendererParent
{
return _dataGroup;
@@ -67,6 +92,14 @@ package org.apache.flex.html.staticControls.beads
private var _vScrollBar:ScrollBar;
+ /**
+ * The vertical ScrollBar, if needed.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get vScrollBar():ScrollBar
{
if (!_vScrollBar)
@@ -74,23 +107,45 @@ package org.apache.flex.html.staticControls.beads
return _vScrollBar;
}
+ /**
+ * The horizontal ScrollBar, currently null.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get hScrollBar():ScrollBar
{
return null;
}
+ /**
+ * The contentArea includes the dataGroup and ScrollBars.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get contentView():DisplayObjectContainer
{
return _dataGroup as DisplayObjectContainer;
}
+ /**
+ * @private
+ */
public function get resizableView():DisplayObject
{
return _strand as DisplayObject;
}
-
+
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function get strand():IStrand
{
return _strand;
@@ -125,6 +180,9 @@ package org.apache.flex.html.staticControls.beads
private var lastSelectedIndex:int = -1;
+ /**
+ * @private
+ */
private function selectionChangeHandler(event:Event):void
{
if (lastSelectedIndex != -1)
@@ -142,6 +200,9 @@ package org.apache.flex.html.staticControls.beads
private var lastRollOverIndex:int = -1;
+ /**
+ * @private
+ */
private function rollOverIndexChangeHandler(event:Event):void
{
if (lastRollOverIndex != -1)
@@ -157,6 +218,9 @@ package org.apache.flex.html.staticControls.beads
lastRollOverIndex = IRollOverModel(listModel).rollOverIndex;
}
+ /**
+ * @private
+ */
private function createScrollBar():ScrollBar
{
var vsb:ScrollBar;
@@ -175,6 +239,9 @@ package org.apache.flex.html.staticControls.beads
return vsb;
}
+ /**
+ * @private
+ */
private function handleSizeChange(event:Event):void
{
UIBase(_dataGroup).x = 0;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/NumericStepperView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/NumericStepperView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/NumericStepperView.as
index 27308ef..bbe07af 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/NumericStepperView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/NumericStepperView.as
@@ -36,8 +36,26 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.supportClasses.Border;
import org.apache.flex.html.staticControls.supportClasses.ScrollBar;
+ /**
+ * The NumericStepperView class creates the visual elements of the NumericStepper component. A
+ * NumberStepper consists of a TextInput component to display the value and a Spinner to change
+ * the value.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class NumericStepperView implements IBeadView, ILayoutParent
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function NumericStepperView()
{
}
@@ -48,6 +66,9 @@ package org.apache.flex.html.staticControls.beads
private var input:TextInput;
private var spinner:Spinner;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -94,6 +115,9 @@ package org.apache.flex.html.staticControls.beads
UIBase(value).height = spinner.height;
}
+ /**
+ * @private
+ */
private function sizeChangeHandler(event:Event) : void
{
input.x = 2;
@@ -103,6 +127,9 @@ package org.apache.flex.html.staticControls.beads
spinner.y = 0;
}
+ /**
+ * @private
+ */
private function spinnerValueChanged(event:Event) : void
{
input.text = String(spinner.value);
@@ -111,6 +138,9 @@ package org.apache.flex.html.staticControls.beads
IEventDispatcher(_strand).dispatchEvent(newEvent);
}
+ /**
+ * @private
+ */
private function inputChangeHandler(event:Event) : void
{
var newValue:Number = Number(input.text);
@@ -123,32 +153,55 @@ package org.apache.flex.html.staticControls.beads
}
}
+ /**
+ * @private
+ */
private function modelChangeHandler( event:Event ) : void
{
var n:Number = IRangeModel(UIBase(_strand).model).value;
input.text = String(IRangeModel(UIBase(_strand).model).value);
}
+ /**
+ * The area containing the TextInput and Spinner controls.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get contentView():DisplayObjectContainer
{
return _strand as DisplayObjectContainer;
}
+ /**
+ * @private
+ */
public function get border():Border
{
return null;
}
+ /**
+ * @private
+ */
public function get vScrollBar():ScrollBar
{
return null;
}
+ /**
+ * @private
+ */
public function get hScrollBar():ScrollBar
{
return null;
}
+ /**
+ * @private
+ */
public function get resizableView():DisplayObject
{
return _strand as DisplayObject;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/PanelView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/PanelView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/PanelView.as
index f7fcd70..95d1a7c 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/PanelView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/PanelView.as
@@ -33,20 +33,55 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.TitleBar;
import org.apache.flex.utils.BeadMetrics;
+ /**
+ * The Panel class creates the visual elements of the Panel component. A Panel
+ * has a TitleBar, content, and an optional ControlBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class PanelView extends ContainerView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function PanelView()
{
_titleBar = new TitleBar();
}
private var _titleBar:TitleBar;
+
+ /**
+ * The TitleBar component of the Panel.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get titleBar():TitleBar
{
return _titleBar;
}
private var _controlBar:ControlBar;
+
+ /**
+ * The ControlBar for the Panel; may be null.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get controlBar():ControlBar
{
return _controlBar;
@@ -54,6 +89,9 @@ package org.apache.flex.html.staticControls.beads
private var _strand:IStrand;
+ /**
+ * @private
+ */
override public function set strand(value:IStrand):void
{
super.strand = value;
@@ -80,6 +118,9 @@ package org.apache.flex.html.staticControls.beads
}
+ /**
+ * @private
+ */
private function changeHandler(event:Event):void
{
var metrics:UIMetrics = BeadMetrics.getMetrics(_strand);
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/RadioButtonView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/RadioButtonView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/RadioButtonView.as
index d356e88..a010bf7 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/RadioButtonView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/RadioButtonView.as
@@ -30,8 +30,24 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IValueToggleButtonModel;
import org.apache.flex.events.Event;
+ /**
+ * The RadioButtonView class creates the visual elements of the RadioButton component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class RadioButtonView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function RadioButtonView()
{
sprites = [ upSprite = new Sprite(),
@@ -65,6 +81,14 @@ package org.apache.flex.html.staticControls.beads
private var _toggleButtonModel:IValueToggleButtonModel;
+ /**
+ * The model used for the RadioButton.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get toggleButtonModel() : IValueToggleButtonModel
{
return _toggleButtonModel;
@@ -72,6 +96,9 @@ package org.apache.flex.html.staticControls.beads
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -106,12 +133,19 @@ package org.apache.flex.html.staticControls.beads
}
}
+ /**
+ * The string label for the RadioButton.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get text():String
{
var tf:CSSTextField = upSprite.getChildByName('textField') as CSSTextField;
return tf.text;
}
-
public function set text(value:String):void
{
for each( var s:Sprite in sprites )
@@ -123,12 +157,19 @@ package org.apache.flex.html.staticControls.beads
layoutControl();
}
+ /**
+ * The HTML string for the RadioButton.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get html():String
{
var tf:CSSTextField = upSprite.getChildByName('textField') as CSSTextField;
return tf.htmlText;
}
-
public function set html(value:String):void
{
for each(var s:Sprite in sprites)
@@ -140,11 +181,17 @@ package org.apache.flex.html.staticControls.beads
layoutControl();
}
+ /**
+ * @private
+ */
private function textChangeHandler(event:Event):void
{
text = toggleButtonModel.text;
}
+ /**
+ * @private
+ */
private function htmlChangeHandler(event:Event):void
{
html = toggleButtonModel.html;
@@ -152,11 +199,13 @@ package org.apache.flex.html.staticControls.beads
private var _selected:Boolean;
+ /**
+ * The selection state of the RadioButton
+ */
public function get selected():Boolean
{
return _selected;
}
-
public function set selected(value:Boolean):void
{
_selected = value;
@@ -175,11 +224,17 @@ package org.apache.flex.html.staticControls.beads
layoutControl();
}
+ /**
+ * @private
+ */
private function selectedValueChangeHandler(event:Event):void
{
selected = _toggleButtonModel.value == _toggleButtonModel.selectedValue;
}
+ /**
+ * @private
+ */
protected function layoutControl() : void
{
for each(var s:Sprite in sprites)
@@ -200,6 +255,9 @@ package org.apache.flex.html.staticControls.beads
}
+ /**
+ * @private
+ */
protected function drawRadioButton(icon:Shape) : void
{
icon.graphics.clear();
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SimpleAlertView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SimpleAlertView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SimpleAlertView.as
index b5748d0..be45524 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SimpleAlertView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SimpleAlertView.as
@@ -33,8 +33,24 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.TextButton;
import org.apache.flex.utils.BeadMetrics;
+ /**
+ * The SimpleAlertView class creates the visual elements of the SimpleAlert component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class SimpleAlertView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SimpleAlertView()
{
}
@@ -43,6 +59,10 @@ package org.apache.flex.html.staticControls.beads
private var okButton:TextButton;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -88,6 +108,9 @@ package org.apache.flex.html.staticControls.beads
handleMessageChange(null);
}
+ /**
+ * @private
+ */
private function handleMessageChange(event:Event):void
{
var ruler:IMeasurementBead = messageLabel.getBeadByType(IMeasurementBead) as IMeasurementBead;
@@ -109,6 +132,9 @@ package org.apache.flex.html.staticControls.beads
UIBase(_strand).height = okButton.y + okButton.height + metrics.bottom;
}
+ /**
+ * @private
+ */
private function handleOK(event:Event):void
{
var newEvent:Event = new Event("close");
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderThumbView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderThumbView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderThumbView.as
index b6a94f4..68f0253 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderThumbView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderThumbView.as
@@ -27,8 +27,25 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.events.Event;
import org.apache.flex.events.IEventDispatcher;
+ /**
+ * The SliderThumbView class creates the draggable input element for the Slider
+ * component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class SliderThumbView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SliderThumbView()
{
hitArea = new Shape();
@@ -37,6 +54,9 @@ package org.apache.flex.html.staticControls.beads
overView = new Shape();
}
+ /**
+ * @private
+ */
private function drawView(g:Graphics, bgColor:uint):void
{
g.clear();
@@ -50,6 +70,9 @@ package org.apache.flex.html.staticControls.beads
private var hitArea:Shape;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -72,6 +95,9 @@ package org.apache.flex.html.staticControls.beads
private var downView:Shape;
private var overView:Shape;
+ /**
+ * @private
+ */
private function sizeChangeHandler( event:Event ) : void
{
drawView(hitArea.graphics, 0xDD0000);
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderTrackView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderTrackView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderTrackView.as
index 6dcc5ae..7d9073a 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderTrackView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderTrackView.as
@@ -27,8 +27,25 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.events.Event;
import org.apache.flex.events.IEventDispatcher;
+ /**
+ * The SliderTrackView class creates the track area for the Slider
+ * component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class SliderTrackView implements IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SliderTrackView()
{
hitArea = new Shape();
@@ -37,6 +54,9 @@ package org.apache.flex.html.staticControls.beads
overView = new Shape();
}
+ /**
+ * @private
+ */
private function drawView(g:Graphics, bgColor:uint):void
{
g.clear();
@@ -50,6 +70,9 @@ package org.apache.flex.html.staticControls.beads
private var hitArea:Shape;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -72,6 +95,9 @@ package org.apache.flex.html.staticControls.beads
private var downView:Shape;
private var overView:Shape;
+ /**
+ * @private
+ */
private function sizeChangeHandler( event:Event ) : void
{
drawView(hitArea.graphics, 0xDD0000);
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderView.as
index a969c25..585a269 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SliderView.as
@@ -32,8 +32,25 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.Button;
+ /**
+ * The SliderView class creates the visual elements of the Slider component. 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
+ */
public class SliderView implements ISliderView, IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SliderView()
{
}
@@ -41,6 +58,10 @@ package org.apache.flex.html.staticControls.beads
private var rangeModel:IRangeModel;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -83,16 +104,35 @@ package org.apache.flex.html.staticControls.beads
private var _track:DisplayObject;
private var _thumb:DisplayObject;
+ /**
+ * The track component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get track():DisplayObject
{
return _track;
}
+ /**
+ * The thumb component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get thumb():DisplayObject
{
return _thumb;
}
+ /**
+ * @private
+ */
private function sizeChangeHandler( event:Event ) : void
{
var w:Number = UIBase(_strand).width;
@@ -113,11 +153,17 @@ package org.apache.flex.html.staticControls.beads
_track.y = (UIBase(_strand).height - _track.height)/2;
}
+ /**
+ * @private
+ */
private function modelChangeHandler( event:Event ) : void
{
setThumbPositionFromValue(rangeModel.value);
}
+ /**
+ * @private
+ */
private function setThumbPositionFromValue( value:Number ) : void
{
var p:Number = (value-rangeModel.minimum)/(rangeModel.maximum-rangeModel.minimum);
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SpinnerView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SpinnerView.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SpinnerView.as
index 0590f71..c11274b 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SpinnerView.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/SpinnerView.as
@@ -30,8 +30,24 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.html.staticControls.Button;
import org.apache.flex.html.staticControls.beads.controllers.ButtonAutoRepeatController;
+ /**
+ * The SpinnerView class creates the visual elements of the Spinner component.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class SpinnerView implements ISpinnerView, IBeadView
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SpinnerView()
{
}
@@ -39,6 +55,10 @@ package org.apache.flex.html.staticControls.beads
private var rangeModel:IRangeModel;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -66,15 +86,35 @@ package org.apache.flex.html.staticControls.beads
private var _decrement:DisplayObject;
private var _increment:DisplayObject;
+ /**
+ * The component for decrementing the Spinner value.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get decrement():DisplayObject
{
return _decrement;
}
+
+ /**
+ * The component for incrementing the Spinner value.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get increment():DisplayObject
{
return _increment;
}
+ /**
+ * @private
+ */
private function sizeChangeHandler( event:Event ) : void
{
_increment.width = UIBase(_strand).width;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextButtonMeasurementBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextButtonMeasurementBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextButtonMeasurementBead.as
index c6e3b6d..f1fdd65 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextButtonMeasurementBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextButtonMeasurementBead.as
@@ -21,12 +21,36 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IMeasurementBead;
import org.apache.flex.core.IStrand;
+ /**
+ * The TextButtonMeasurementBead class helps measure a TextButton.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class TextButtonMeasurementBead implements IMeasurementBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function TextButtonMeasurementBead()
{
}
+ /**
+ * The overall width of the TextButton.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredWidth():Number
{
var view:TextButtonView = _strand.getBeadByType(TextButtonView) as TextButtonView;
@@ -34,6 +58,9 @@ package org.apache.flex.html.staticControls.beads
else return 0;
}
+ /**
+ * The overall height of the TextButton
+ */
public function get measuredHeight():Number
{
var view:TextButtonView = _strand.getBeadByType(TextButtonView) as TextButtonView;
@@ -42,6 +69,10 @@ package org.apache.flex.html.staticControls.beads
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextFieldLabelMeasurementBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextFieldLabelMeasurementBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextFieldLabelMeasurementBead.as
index dd21abd..62b21bd 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextFieldLabelMeasurementBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TextFieldLabelMeasurementBead.as
@@ -21,12 +21,36 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.IMeasurementBead;
import org.apache.flex.core.IStrand;
+ /**
+ * The TextFieldLabelMeasurementBead class helps to measure TextField components.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class TextFieldLabelMeasurementBead implements IMeasurementBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function TextFieldLabelMeasurementBead()
{
}
+ /**
+ * The overall width of the TextField.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredWidth():Number
{
var view:TextFieldView = _strand.getBeadByType(TextFieldView) as TextFieldView;
@@ -34,6 +58,14 @@ package org.apache.flex.html.staticControls.beads
else return 0;
}
+ /**
+ * The overall height of the TextField.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredHeight():Number
{
var view:TextFieldView = _strand.getBeadByType(TextFieldView) as TextFieldView;
@@ -42,6 +74,10 @@ package org.apache.flex.html.staticControls.beads
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/11f443ad/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TitleBarMeasurementBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TitleBarMeasurementBead.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TitleBarMeasurementBead.as
index 221120a..87cc7be 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TitleBarMeasurementBead.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/TitleBarMeasurementBead.as
@@ -23,12 +23,36 @@ package org.apache.flex.html.staticControls.beads
import org.apache.flex.core.ValuesManager;
import org.apache.flex.html.staticControls.TitleBar;
+ /**
+ * The TitleBarMeasurementBead class measures the overall size of a TitleBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class TitleBarMeasurementBead implements IMeasurementBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function TitleBarMeasurementBead()
{
}
+ /**
+ * The overall width of the TitleBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredWidth():Number
{
var mwidth:Number = 0;
@@ -42,6 +66,14 @@ package org.apache.flex.html.staticControls.beads
return mwidth;
}
+ /**
+ * The overall height of the TitleBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get measuredHeight():Number
{
var mheight:Number = 0;
@@ -56,6 +88,10 @@ package org.apache.flex.html.staticControls.beads
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
|