You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by pe...@apache.org on 2014/02/04 22:47:39 UTC
git commit: [flex-asjs] [refs/heads/develop] - More asdoc work.
Updated Branches:
refs/heads/develop 0053fff98 -> f34a6629a
More asdoc work.
Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/f34a6629
Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/f34a6629
Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/f34a6629
Branch: refs/heads/develop
Commit: f34a6629adba9bf4cc109ecb24fcb01d36486626
Parents: 0053fff
Author: Peter Ent <pe...@apache.org>
Authored: Tue Feb 4 16:47:28 2014 -0500
Committer: Peter Ent <pe...@apache.org>
Committed: Tue Feb 4 16:47:28 2014 -0500
----------------------------------------------------------------------
.../beads/controllers/AlertController.as | 26 +++++
.../beads/controllers/ComboBoxController.as | 27 +++++
.../EditableTextKeyboardController.as | 24 +++++
.../controllers/ItemRendererMouseController.as | 33 ++++++
.../beads/controllers/SliderMouseController.as | 35 +++++++
.../beads/controllers/SpinnerMouseController.as | 27 +++++
.../beads/layouts/ButtonBarLayout.as | 35 +++++++
.../staticControls/beads/models/AlertModel.as | 102 +++++++++++++++++++
.../beads/models/ComboBoxModel.as | 35 +++++++
.../beads/models/DataGridModel.as | 26 +++++
.../staticControls/beads/models/ImageModel.as | 29 ++++++
.../staticControls/beads/models/PanelModel.as | 51 +++++++++-
.../staticControls/beads/models/RangeModel.as | 71 ++++++++++++-
.../beads/models/ScrollBarModel.as | 35 +++++++
.../beads/models/TitleBarModel.as | 38 +++++++
.../beads/models/ToggleButtonModel.as | 45 ++++++++
.../beads/models/ValueToggleButtonModel.as | 41 ++++++++
.../ButtonBarButtonItemRenderer.as | 43 ++++++++
.../supportClasses/DataItemRenderer.as | 50 +++++++++
.../staticControls/supportClasses/ScrollBar.as | 18 ++++
.../supportClasses/StringItemRenderer.as | 42 ++++++++
.../supportClasses/TextFieldItemRenderer.as | 94 +++++++++++++++++
.../supportClasses/UIItemRendererBase.as | 89 ++++++++++++++++
23 files changed, 1012 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/AlertController.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/AlertController.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/AlertController.as
index 01ba18a..c44cac9 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/AlertController.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/AlertController.as
@@ -25,25 +25,51 @@ package org.apache.flex.html.staticControls.beads.controllers
import org.apache.flex.events.Event;
import org.apache.flex.events.IEventDispatcher;
+ /**
+ * The AlertControler class bead handles the close event on the Alert by removing the
+ * Alert from the display.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class AlertController implements IBeadController
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function AlertController()
{
}
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function get strand():IStrand
{
return _strand;
}
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
IEventDispatcher(value).addEventListener("close",handleAlertClose);
}
+ /**
+ * @private
+ */
private function handleAlertClose(event:Event):void
{
DisplayObject(_strand).parent.removeChild(DisplayObject(_strand));
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ComboBoxController.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ComboBoxController.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ComboBoxController.as
index ed2d228..4ecfbad 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ComboBoxController.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ComboBoxController.as
@@ -28,20 +28,44 @@ package org.apache.flex.html.staticControls.beads.controllers
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.beads.IComboBoxView;
+ /**
+ * The ComboBoxController class bead handles mouse events on the elements of
+ * the ComboBox. This includes selecting the button to display the selection list
+ * pop-up as well as selecting an item from the pop-up list.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ComboBoxController implements IBeadController
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ComboBoxController()
{
}
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
IEventDispatcher(value).addEventListener(MouseEvent.CLICK, clickHandler);
}
+ /**
+ * @private
+ */
private function clickHandler(event:MouseEvent):void
{
var viewBead:IComboBoxView = _strand.getBeadByType(IComboBoxView) as IComboBoxView;
@@ -57,6 +81,9 @@ package org.apache.flex.html.staticControls.beads.controllers
IEventDispatcher(viewBead.popUp).addEventListener("change", changeHandler);
}
+ /**
+ * @private
+ */
private function changeHandler(event:Event):void
{
var viewBead:IComboBoxView = _strand.getBeadByType(IComboBoxView) as IComboBoxView;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/EditableTextKeyboardController.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/EditableTextKeyboardController.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/EditableTextKeyboardController.as
index e505217..6503457 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/EditableTextKeyboardController.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/EditableTextKeyboardController.as
@@ -26,8 +26,25 @@ package org.apache.flex.html.staticControls.beads.controllers
import org.apache.flex.core.UIBase;
import org.apache.flex.html.staticControls.beads.ITextFieldView;
+ /**
+ * The EditableTextKeyboardController class bead intercepts keyboard events on the
+ * component's text field and emits change events.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class EditableTextKeyboardController implements IBead, IBeadController
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function EditableTextKeyboardController()
{
}
@@ -36,6 +53,10 @@ package org.apache.flex.html.staticControls.beads.controllers
private var textField:CSSTextField;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -47,6 +68,9 @@ package org.apache.flex.html.staticControls.beads.controllers
textField.addEventListener("change", inputChangeHandler);
}
+ /**
+ * @private
+ */
private function inputChangeHandler( event:Object ) : void
{
model.text = textField.text;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ItemRendererMouseController.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ItemRendererMouseController.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ItemRendererMouseController.as
index 1a70434..c6c3a81 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ItemRendererMouseController.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/ItemRendererMouseController.as
@@ -25,8 +25,26 @@ package org.apache.flex.html.staticControls.beads.controllers
import org.apache.flex.core.IStrand;
import org.apache.flex.events.Event;
+ /**
+ * The ItemRendererMouseController class bead handles mouse events in itemRenderers. This
+ * includes roll-overs, mouse down, and mouse up. These platform-specific events are then
+ * re-dispatched as FlexJS events.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ItemRendererMouseController implements IBeadController
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ItemRendererMouseController()
{
}
@@ -34,6 +52,9 @@ package org.apache.flex.html.staticControls.beads.controllers
private var renderer:IItemRenderer;
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -43,6 +64,9 @@ package org.apache.flex.html.staticControls.beads.controllers
renderer.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
}
+ /**
+ * @private
+ */
protected function rollOverHandler(event:MouseEvent):void
{
var target:IItemRenderer = event.target as IItemRenderer;
@@ -53,6 +77,9 @@ package org.apache.flex.html.staticControls.beads.controllers
}
}
+ /**
+ * @private
+ */
protected function rollOutHandler(event:MouseEvent):void
{
var target:IItemRenderer = event.target as IItemRenderer;
@@ -63,6 +90,9 @@ package org.apache.flex.html.staticControls.beads.controllers
}
}
+ /**
+ * @private
+ */
protected function mouseDownHandler(event:MouseEvent):void
{
var target:IItemRenderer = event.currentTarget as IItemRenderer;
@@ -73,6 +103,9 @@ package org.apache.flex.html.staticControls.beads.controllers
}
}
+ /**
+ * @private
+ */
protected function mouseUpHandler(event:MouseEvent):void
{
var target:IItemRenderer = event.currentTarget as IItemRenderer;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SliderMouseController.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SliderMouseController.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SliderMouseController.as
index 60c153a..b4eccbf 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SliderMouseController.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SliderMouseController.as
@@ -30,8 +30,27 @@ package org.apache.flex.html.staticControls.beads.controllers
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.beads.ISliderView;
+ /**
+ * The SliderMouseController class bead handles mouse events on the Slider's component
+ * parts (thumb and track) and dispatches change events on behalf of the Slider (as well
+ * as co-ordinating visual changes (such as moving the thumb when the track has been
+ * tapped or clicked).
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class SliderMouseController implements IBead, IBeadController
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SliderMouseController()
{
}
@@ -39,6 +58,10 @@ package org.apache.flex.html.staticControls.beads.controllers
private var rangeModel:IRangeModel;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -52,6 +75,9 @@ package org.apache.flex.html.staticControls.beads.controllers
sliderView.track.addEventListener(MouseEvent.CLICK, trackClickHandler, false, 99999);
}
+ /**
+ * @private
+ */
private function thumbDownHandler( event:MouseEvent ) : void
{
UIBase(_strand).stage.addEventListener(MouseEvent.MOUSE_MOVE, thumbMoveHandler);
@@ -63,6 +89,9 @@ package org.apache.flex.html.staticControls.beads.controllers
thumb = new Point(sliderView.thumb.x,sliderView.thumb.y);
}
+ /**
+ * @private
+ */
private function thumbUpHandler( event:MouseEvent ) : void
{
UIBase(_strand).stage.removeEventListener(MouseEvent.MOUSE_MOVE, thumbMoveHandler);
@@ -74,6 +103,9 @@ package org.apache.flex.html.staticControls.beads.controllers
private var origin:Point;
private var thumb:Point;
+ /**
+ * @private
+ */
private function thumbMoveHandler( event:MouseEvent ) : void
{
var sliderView:ISliderView = _strand.getBeadByType(ISliderView) as ISliderView;
@@ -90,6 +122,9 @@ package org.apache.flex.html.staticControls.beads.controllers
IEventDispatcher(_strand).dispatchEvent(new Event("valueChanged"));
}
+ /**
+ * @private
+ */
private function trackClickHandler( event:MouseEvent ) : void
{
event.stopImmediatePropagation();
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SpinnerMouseController.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SpinnerMouseController.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SpinnerMouseController.as
index abb7e97..6fa35eb 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SpinnerMouseController.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/controllers/SpinnerMouseController.as
@@ -28,8 +28,25 @@ package org.apache.flex.html.staticControls.beads.controllers
import org.apache.flex.events.IEventDispatcher;
import org.apache.flex.html.staticControls.beads.ISpinnerView;
+ /**
+ * The SpinnerMouseController class bead handles mouse events on the Spinner's
+ * component buttons, changing the value of the Spinner.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class SpinnerMouseController implements IBeadController
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function SpinnerMouseController()
{
}
@@ -37,6 +54,10 @@ package org.apache.flex.html.staticControls.beads.controllers
private var rangeModel:IRangeModel;
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -50,12 +71,18 @@ package org.apache.flex.html.staticControls.beads.controllers
spinnerBead.increment.addEventListener("buttonRepeat", incrementClickHandler);
}
+ /**
+ * @private
+ */
private function decrementClickHandler( event:Event ) : void
{
rangeModel.value = Math.max(rangeModel.minimum, rangeModel.value - rangeModel.stepSize);
IEventDispatcher(_strand).dispatchEvent(new Event("valueChanged"));
}
+ /**
+ * @private
+ */
private function incrementClickHandler( event:Event ) : void
{
rangeModel.value = Math.min(rangeModel.maximum, rangeModel.value + rangeModel.stepSize);
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/layouts/ButtonBarLayout.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/layouts/ButtonBarLayout.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/layouts/ButtonBarLayout.as
index 80ad0fa..7d111d5 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/layouts/ButtonBarLayout.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/layouts/ButtonBarLayout.as
@@ -28,14 +28,36 @@ package org.apache.flex.html.staticControls.beads.layouts
import org.apache.flex.events.Event;
import org.apache.flex.events.IEventDispatcher;
+ /**
+ * The ButtonBarLayout class bead sizes and positions the Button elements that
+ * make up a ButtonBar. This bead arranges the Buttons horizontally and makes them
+ * all the same width unless the buttonWidths property has been set in which case
+ * the values stored in that array are used.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ButtonBarLayout implements IBeadLayout
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ButtonBarLayout()
{
}
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
@@ -45,6 +67,16 @@ package org.apache.flex.html.staticControls.beads.layouts
}
private var _buttonWidths:Array = null;
+
+ /**
+ * An array of widths (Number), one per button. These values supersede the
+ * default of equally-sized buttons.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get buttonWidths():Array
{
return _buttonWidths;
@@ -54,6 +86,9 @@ package org.apache.flex.html.staticControls.beads.layouts
_buttonWidths = value;
}
+ /**
+ * @private
+ */
private function changeHandler(event:Event):void
{
var layoutParent:ILayoutParent = _strand.getBeadByType(ILayoutParent) as ILayoutParent;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/AlertModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/AlertModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/AlertModel.as
index 12deea4..46c9d73 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/AlertModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/AlertModel.as
@@ -24,20 +24,50 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.events.Event;
import org.apache.flex.events.EventDispatcher;
+ /**
+ * The AlertModel class bead implements the IAlertModel and holds the properties
+ * for an Alert such the buttons to use and message to display.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class AlertModel extends EventDispatcher implements IAlertModel, IBead
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function AlertModel()
{
super();
}
private var _strand:IStrand;
+
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
}
private var _title:String;
+
+ /**
+ * The title for the Alert.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get title():String
{
return _title;
@@ -51,6 +81,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _htmlTitle:String;
+
+ /**
+ * The HTML title for the Alert.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get htmlTitle():String
{
return _htmlTitle;
@@ -64,6 +103,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _message:String;
+
+ /**
+ * The message to display.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get message():String
{
return _message;
@@ -77,6 +125,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _htmlMessage:String;
+
+ /**
+ * The HTML message to display.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get htmlMessage():String
{
return _htmlMessage;
@@ -91,6 +148,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _flags:uint;
+
+ /**
+ * Which buttons to display (see Alert for details).
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get flags():uint
{
return _flags;
@@ -105,6 +171,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _okLabel:String = "OK";
+
+ /**
+ * The label to use for the OK button.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get okLabel():String
{
return _okLabel;
@@ -119,6 +194,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _cancelLabel:String = "Cancel";
+
+ /**
+ * The label to use for the Cancel button.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get cancelLabel():String
{
return _cancelLabel;
@@ -133,6 +217,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _yesLabel:String = "YES";
+
+ /**
+ * The label to use for the Yes button.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get yesLabel():String
{
return _yesLabel;
@@ -147,6 +240,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _noLabel:String = "NO";
+
+ /**
+ * The label to use for the NO button.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get noLabel():String
{
return _noLabel;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ComboBoxModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ComboBoxModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ComboBoxModel.as
index 91d2ce0..5ab8d48 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ComboBoxModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ComboBoxModel.as
@@ -22,13 +22,39 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.core.IComboBoxModel;
import org.apache.flex.events.Event;
+ /**
+ * The ComboBoxModel class bead extends ArraySelectionModel and adds the text being
+ * displayed by the ComboBox's input field.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ComboBoxModel extends ArraySelectionModel implements IBead, IComboBoxModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ComboBoxModel()
{
}
private var _text:String;
+
+ /**
+ * The string to display in the ComboBox input field.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get text():String
{
return _text;
@@ -44,6 +70,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _html:String;
+
+ /**
+ * The HTML string to display in the ComboBox input field.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get html():String
{
return _html;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/DataGridModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/DataGridModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/DataGridModel.as
index fb607ba..0fff6b8 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/DataGridModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/DataGridModel.as
@@ -21,14 +21,40 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.core.IDataGridModel;
import org.apache.flex.events.Event;
+ /**
+ * The DataGridModel class bead extends ArraySelectionModel and adds the array
+ * of DataGridColumns used to define each of the column in the DataGrid.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class DataGridModel extends ArraySelectionModel implements IDataGridModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function DataGridModel()
{
super();
}
private var _columns:Array;
+
+ /**
+ * The array of DataGridColumns used to define each column of the DataGrid.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get columns():Array
{
return _columns;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ImageModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ImageModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ImageModel.as
index c6e3e80..6e2e594 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ImageModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ImageModel.as
@@ -23,8 +23,25 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.events.Event;
import org.apache.flex.events.EventDispatcher;
+ /**
+ * The ImageModel class bead defines the data associated with an Image
+ * component, namely the source of the image.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ImageModel extends EventDispatcher implements IImageModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ImageModel()
{
super();
@@ -32,12 +49,24 @@ package org.apache.flex.html.staticControls.beads.models
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
}
private var _source:String;
+
+ /**
+ * The source of the image.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get source():String
{
return _source;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/PanelModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/PanelModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/PanelModel.as
index 19c61aa..e68f519 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/PanelModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/PanelModel.as
@@ -24,25 +24,54 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.events.Event;
import org.apache.flex.events.EventDispatcher;
+ /**
+ * The PanelModel bead class holds the values for a Panel, such as its
+ * title.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class PanelModel extends EventDispatcher implements IBead, IPanelModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function PanelModel()
{
super();
}
+
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
}
private var _title:String;
+
+ /**
+ * The title string for the Panel.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get title():String
{
return _title;
}
-
public function set title(value:String):void
{
if( value != _title ) {
@@ -52,11 +81,19 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _htmlTitle:String;
+
+ /**
+ * The HTML string for the title.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get htmlTitle():String
{
return _htmlTitle;
}
-
public function set htmlTitle(value:String):void
{
if( value != _htmlTitle ) {
@@ -66,11 +103,19 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _showCloseButton:Boolean = false;
+
+ /**
+ * Indicates whether or not there is a Close button for the Panel.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get showCloseButton():Boolean
{
return _showCloseButton;
}
-
public function set showCloseButton(value:Boolean):void
{
if( value != _showCloseButton ) {
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/RangeModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/RangeModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/RangeModel.as
index 4b475be..cf61cab 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/RangeModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/RangeModel.as
@@ -24,20 +24,49 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.events.Event;
import org.apache.flex.events.EventDispatcher;
+ /**
+ * The RangeModel class bead defines a set of for a numeric range of values
+ * which includes a minimum, maximum, and current value.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class RangeModel extends EventDispatcher implements IBead, IRangeModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function RangeModel()
{
}
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
}
private var _maximum:Number = 100;
+
+ /**
+ * The maximum value for the range (defaults to 100).
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get maximum():Number
{
return _maximum;
@@ -53,6 +82,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _minimum:Number = 0;
+
+ /**
+ * The minimum value for the range (defaults to 0).
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get minimum():Number
{
return _minimum;
@@ -68,6 +106,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _snapInterval:Number = 1;
+
+ /**
+ * The modulus value for the range.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get snapInterval():Number
{
return _snapInterval;
@@ -83,6 +130,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _stepSize:Number = 1;
+
+ /**
+ * The amount to adjust the value either up or down toward the edge of the range.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get stepSize():Number
{
return _stepSize;
@@ -98,6 +154,17 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _value:Number = 0;
+
+ /**
+ * The current value of the range, between the minimum and maximum values. Attempting
+ * to set the value outside of the minimum-maximum range changes the value to still be
+ * within the range. Note that the value is adjusted by the stepSize.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get value():Number
{
return _value;
@@ -117,7 +184,9 @@ package org.apache.flex.html.staticControls.beads.models
}
}
-
+ /**
+ * @private
+ */
protected function snap(value:Number):Number
{
var si:Number = snapInterval;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ScrollBarModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ScrollBarModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ScrollBarModel.as
index ce2e52d..7b19c5f 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ScrollBarModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ScrollBarModel.as
@@ -22,13 +22,39 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.core.IScrollBarModel;
import org.apache.flex.events.Event;
+ /**
+ * The ScrollBarModel class bead extends the RangeModel and added page size
+ * and page step sizes.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ScrollBarModel extends RangeModel implements IScrollBarModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ScrollBarModel()
{
}
private var _pageSize:Number;
+
+ /**
+ * The amount represented by the thumb control of the ScrollBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get pageSize():Number
{
return _pageSize;
@@ -44,6 +70,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _pageStepSize:Number;
+
+ /**
+ * The amount to adjust the ScrollBar if the scroll bar's track area is selected.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get pageStepSize():Number
{
return _pageStepSize;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/TitleBarModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/TitleBarModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/TitleBarModel.as
index d72fab9..68bf494 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/TitleBarModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/TitleBarModel.as
@@ -24,6 +24,14 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.events.Event;
import org.apache.flex.events.EventDispatcher;
+ /**
+ * The TitleBarModel class bead holds the values for the TitleBar's properties.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class TitleBarModel extends EventDispatcher implements IBead, ITitleBarModel
{
public function TitleBarModel()
@@ -33,12 +41,24 @@ package org.apache.flex.html.staticControls.beads.models
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
}
private var _title:String;
+
+ /**
+ * The string title for the TitleBar.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get title():String
{
return _title;
@@ -53,6 +73,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _htmlTitle:String;
+
+ /**
+ * The HTML string for the title.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get htmlTitle():String
{
return _htmlTitle;
@@ -67,6 +96,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _showCloseButton:Boolean = false;
+
+ /**
+ * Whether or not to show a close button.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get showCloseButton():Boolean
{
return _showCloseButton;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ToggleButtonModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ToggleButtonModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ToggleButtonModel.as
index c96e101..f970ec9 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ToggleButtonModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ToggleButtonModel.as
@@ -24,8 +24,24 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.events.Event;
import org.apache.flex.events.EventDispatcher;
+ /**
+ * The ToggleButtonModel class bead holds values for Buttons that have a state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ToggleButtonModel extends EventDispatcher implements IBead, IToggleButtonModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ToggleButtonModel()
{
super();
@@ -33,12 +49,24 @@ package org.apache.flex.html.staticControls.beads.models
private var _strand:IStrand;
+ /**
+ * @private
+ */
public function set strand(value:IStrand):void
{
_strand = value;
}
private var _text:String;
+
+ /**
+ * The text string for the Button's label.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get text():String
{
return _text;
@@ -54,6 +82,15 @@ package org.apache.flex.html.staticControls.beads.models
}
private var _html:String;
+
+ /**
+ * The HTML string for the Button's label.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get html():String
{
return _html;
@@ -70,6 +107,14 @@ package org.apache.flex.html.staticControls.beads.models
private var _selected:Boolean;
+ /**
+ * Whether or not the button is selected.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get selected():Boolean
{
return _selected;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ValueToggleButtonModel.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ValueToggleButtonModel.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ValueToggleButtonModel.as
index a1cc0fb..d187d98 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ValueToggleButtonModel.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/beads/models/ValueToggleButtonModel.as
@@ -22,8 +22,25 @@ package org.apache.flex.html.staticControls.beads.models
import org.apache.flex.core.IValueToggleButtonModel;
import org.apache.flex.events.Event;
+ /**
+ * The ValueToggleButtonModel class bead extends the ToggleButtonModel and adds
+ * value intended to represent a collection of similar Buttons such as RadioButtons.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ValueToggleButtonModel extends ToggleButtonModel implements IValueToggleButtonModel
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ValueToggleButtonModel()
{
super();
@@ -31,6 +48,14 @@ package org.apache.flex.html.staticControls.beads.models
private var _value:Object;
+ /**
+ * The current value of the button collection.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get value():Object
{
return _value;
@@ -47,6 +72,14 @@ package org.apache.flex.html.staticControls.beads.models
private var _groupName:String;
+ /**
+ * The name of the collection has shared by all of the buttons in the collection.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get groupName():String
{
return _groupName;
@@ -63,6 +96,14 @@ package org.apache.flex.html.staticControls.beads.models
private var _selectedValue:Object;
+ /**
+ * The value that is currently selected.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get selectedValue():Object
{
return _selectedValue;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ButtonBarButtonItemRenderer.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ButtonBarButtonItemRenderer.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ButtonBarButtonItemRenderer.as
index 2c6ab08..5b0deb5 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ButtonBarButtonItemRenderer.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ButtonBarButtonItemRenderer.as
@@ -24,8 +24,25 @@ package org.apache.flex.html.staticControls.supportClasses
import org.apache.flex.html.staticControls.TextButton;
import org.apache.flex.html.staticControls.beads.ITextItemRenderer;
+ /**
+ * The ButtonBarButtonItemRenderer class handles the display of each item for the ButtonBar component.
+ * This class uses a Button to represent the data.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ButtonBarButtonItemRenderer extends UIItemRendererBase implements ITextItemRenderer
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ButtonBarButtonItemRenderer()
{
super();
@@ -33,16 +50,30 @@ package org.apache.flex.html.staticControls.supportClasses
private var textButton:TextButton;
+ /**
+ * @private
+ */
override public function addedToParent():void
{
super.addedToParent();
}
+ /**
+ * @private
+ */
private function handleClickEvent(event:Event):void
{
this.dispatchEvent(new Event("selected"));
}
+ /**
+ * The string version of the data associated with the instance of the itemRenderer.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get text():String
{
return data as String;
@@ -52,6 +83,15 @@ package org.apache.flex.html.staticControls.supportClasses
data = value;
}
+ /**
+ * The data to be displayed by the itemRenderer instance. For ButtonBarItemRenderer, the
+ * data's string version is used as the label for the Button.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
override public function set data(value:Object):void
{
super.data = value;
@@ -80,6 +120,9 @@ package org.apache.flex.html.staticControls.supportClasses
if (added) addElement(textButton);
}
+ /**
+ * @private
+ */
override public function adjustSize():void
{
textButton.width = this.width;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/DataItemRenderer.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/DataItemRenderer.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/DataItemRenderer.as
index 1eab8a7..a6c6386 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/DataItemRenderer.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/DataItemRenderer.as
@@ -20,14 +20,40 @@ package org.apache.flex.html.staticControls.supportClasses
{
import flash.display.Sprite;
+ /**
+ * The DataItemRenderer class is the base class for most itemRenderers. This class
+ * extends UIItemRendererBase and includes row and column index values.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class DataItemRenderer extends UIItemRendererBase
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function DataItemRenderer()
{
super();
}
private var _columnIndex:int;
+
+ /**
+ * The index of the column the itemRenderer represents.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get columnIndex():int
{
return _columnIndex;
@@ -38,6 +64,15 @@ package org.apache.flex.html.staticControls.supportClasses
}
private var _rowIndex:int;
+
+ /**
+ * The index of the row the itemRenderer represents.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get rowIndex():int
{
return _rowIndex;
@@ -48,6 +83,15 @@ package org.apache.flex.html.staticControls.supportClasses
}
private var _dataField:String;
+
+ /**
+ * The name of the field within the data the itemRenderer should use.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get dataField():String
{
return _dataField;
@@ -59,6 +103,9 @@ package org.apache.flex.html.staticControls.supportClasses
private var background:Sprite;
+ /**
+ * @private
+ */
override public function addedToParent():void
{
super.addedToParent();
@@ -67,6 +114,9 @@ package org.apache.flex.html.staticControls.supportClasses
addChild(background);
}
+ /**
+ * @private
+ */
override public function updateRenderer():void
{
super.updateRenderer();
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ScrollBar.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ScrollBar.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ScrollBar.as
index 2b33d08..f826be0 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ScrollBar.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/ScrollBar.as
@@ -20,8 +20,26 @@ package org.apache.flex.html.staticControls.supportClasses
{
import org.apache.flex.core.UIBase;
+ /**
+ * The ScrollBar class represents either a vertical or horizontal control
+ * that allows the user to quickly scan through a component that does not
+ * wholly fit within its container.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class ScrollBar extends UIBase
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function ScrollBar()
{
super();
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/StringItemRenderer.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/StringItemRenderer.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/StringItemRenderer.as
index 7e041b1..4dd84ee 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/StringItemRenderer.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/StringItemRenderer.as
@@ -25,8 +25,25 @@ package org.apache.flex.html.staticControls.supportClasses
import org.apache.flex.events.Event;
import org.apache.flex.html.staticControls.beads.ITextItemRenderer;
+ /**
+ * The StringItemRenderer class displays data in string form using the data's toString()
+ * function.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class StringItemRenderer extends DataItemRenderer implements ITextItemRenderer
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function StringItemRenderer()
{
super();
@@ -39,6 +56,9 @@ package org.apache.flex.html.staticControls.supportClasses
public var textField:CSSTextField;
+ /**
+ * @private
+ */
override public function addedToParent():void
{
super.addedToParent();
@@ -48,6 +68,9 @@ package org.apache.flex.html.staticControls.supportClasses
adjustSize();
}
+ /**
+ * @private
+ */
override public function adjustSize():void
{
var cy:Number = this.height/2;
@@ -59,6 +82,14 @@ package org.apache.flex.html.staticControls.supportClasses
updateRenderer();
}
+ /**
+ * The text currently displayed by the itemRenderer instance.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get text():String
{
return textField.text;
@@ -69,6 +100,14 @@ package org.apache.flex.html.staticControls.supportClasses
textField.text = value;
}
+ /**
+ * Sets the data value and uses the String version of the data for display.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
override public function set data(value:Object):void
{
super.data = value;
@@ -77,6 +116,9 @@ package org.apache.flex.html.staticControls.supportClasses
else textField.text = String(value);
}
+ /**
+ * @private
+ */
override public function updateRenderer():void
{
super.updateRenderer();
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/TextFieldItemRenderer.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/TextFieldItemRenderer.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/TextFieldItemRenderer.as
index 7b2d61e..e86c6fe 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/TextFieldItemRenderer.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/TextFieldItemRenderer.as
@@ -30,8 +30,24 @@ package org.apache.flex.html.staticControls.supportClasses
import org.apache.flex.events.Event;
import org.apache.flex.html.staticControls.beads.ITextItemRenderer;
+ /**
+ * The TextFieldItemRenderer class provides a TextField as an itemRenderer.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class TextFieldItemRenderer extends CSSTextField implements ITextItemRenderer, IStrand, IUIBase
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function TextFieldItemRenderer()
{
super();
@@ -44,6 +60,10 @@ package org.apache.flex.html.staticControls.supportClasses
public var downColor:uint = 0x808080;
private var _width:Number;
+
+ /**
+ * @private
+ */
override public function get width():Number
{
if (isNaN(_width))
@@ -65,12 +85,20 @@ package org.apache.flex.html.staticControls.supportClasses
dispatchEvent(new Event("widthChanged"));
}
}
+
+ /**
+ * @private
+ */
protected function get $width():Number
{
return super.width;
}
private var _height:Number;
+
+ /**
+ * @private
+ */
override public function get height():Number
{
if (isNaN(_height))
@@ -92,11 +120,23 @@ package org.apache.flex.html.staticControls.supportClasses
dispatchEvent(new Event("heightChanged"));
}
}
+
+ /**
+ * @private
+ */
protected function get $height():Number
{
return super.height;
}
+ /**
+ * The String(data) for the itemRenderer instance.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get data():Object
{
return text;
@@ -106,6 +146,9 @@ package org.apache.flex.html.staticControls.supportClasses
text = String(value);
}
+ /**
+ * @private
+ */
public function get labelField():String
{
return null;
@@ -117,6 +160,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _index:int;
+ /**
+ * An index value for the itemRenderer corresponding the data's position with its dataProvider.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get index():int
{
return _index;
@@ -128,6 +179,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _hovered:Boolean;
+ /**
+ * Returns whether or not the itemRenderer is a "hovered" state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get hovered():Boolean
{
return _hovered;
@@ -140,6 +199,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _selected:Boolean;
+ /**
+ * Whether or not the itemRenderer should be represented in a selected state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get selected():Boolean
{
return _selected;
@@ -152,6 +219,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _down:Boolean;
+ /**
+ * Whether or not the itemRenderer should be represented in a down (or pre-selected) state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get down():Boolean
{
return _down;
@@ -162,6 +237,9 @@ package org.apache.flex.html.staticControls.supportClasses
updateRenderer();
}
+ /**
+ * @private
+ */
public function updateRenderer():void
{
background = (down || selected || hovered);
@@ -173,6 +251,9 @@ package org.apache.flex.html.staticControls.supportClasses
backgroundColor = selectedColor;
}
+ /**
+ * @private
+ */
public function get element():Object
{
return this;
@@ -183,6 +264,10 @@ package org.apache.flex.html.staticControls.supportClasses
public var beads:Array;
private var _beads:Vector.<IBead>;
+
+ /**
+ * @private
+ */
public function addBead(bead:IBead):void
{
if (!_beads)
@@ -191,6 +276,9 @@ package org.apache.flex.html.staticControls.supportClasses
bead.strand = this;
}
+ /**
+ * @private
+ */
public function getBeadByType(classOrInterface:Class):IBead
{
for each (var bead:IBead in _beads)
@@ -201,6 +289,9 @@ package org.apache.flex.html.staticControls.supportClasses
return null;
}
+ /**
+ * @private
+ */
public function removeBead(value:IBead):IBead
{
var n:int = _beads.length;
@@ -216,6 +307,9 @@ package org.apache.flex.html.staticControls.supportClasses
return null;
}
+ /**
+ * @private
+ */
public function addedToParent():void
{
var c:Class;
http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/f34a6629/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/UIItemRendererBase.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/UIItemRendererBase.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/UIItemRendererBase.as
index 215f7a2..b313650 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/UIItemRendererBase.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/html/staticControls/supportClasses/UIItemRendererBase.as
@@ -24,12 +24,33 @@ package org.apache.flex.html.staticControls.supportClasses
import org.apache.flex.events.Event;
import org.apache.flex.utils.MXMLDataInterpreter;
+ /**
+ * The UIItemRendererBase class is the base class for all itemRenderers. An itemRenderer is used to
+ * display a single datum within a collection of data. Components such as a List use itemRenderers to
+ * show their dataProviders.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public class UIItemRendererBase extends UIBase implements IItemRenderer
{
+ /**
+ * constructor.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function UIItemRendererBase()
{
}
+ /**
+ * @private
+ */
override public function addedToParent():void
{
super.addedToParent();
@@ -48,6 +69,9 @@ package org.apache.flex.html.staticControls.supportClasses
}
+ /**
+ * @private
+ */
public function get MXMLDescriptor():Array
{
return null;
@@ -55,6 +79,9 @@ package org.apache.flex.html.staticControls.supportClasses
private var mxmlProperties:Array ;
+ /**
+ * @private
+ */
public function generateMXMLAttributes(data:Array):void
{
mxmlProperties = data;
@@ -67,6 +94,15 @@ package org.apache.flex.html.staticControls.supportClasses
private var _data:Object;
+ /**
+ * The data being represented by this itemRenderer. This can be something simple like a String or
+ * a Number or something very complex.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get data():Object
{
return _data;
@@ -77,6 +113,12 @@ package org.apache.flex.html.staticControls.supportClasses
}
private var _labelField:String = "label";
+
+ /**
+ * The name of the field within the data to use as a label. Some itemRenderers use this field to
+ * identify the value they should show while other itemRenderers ignore this if they are showing
+ * complex information.
+ */
public function get labelField():String
{
return _labelField;
@@ -88,6 +130,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _index:int;
+ /**
+ * The position with the dataProvider being shown by the itemRenderer instance.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get index():int
{
return _index;
@@ -99,6 +149,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _hovered:Boolean;
+ /**
+ * Whether or not the itemRenderer is in a hovered state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get hovered():Boolean
{
return _hovered;
@@ -111,6 +169,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _selected:Boolean;
+ /**
+ * Whether or not the itemRenderer is in a selected state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get selected():Boolean
{
return _selected;
@@ -123,6 +189,14 @@ package org.apache.flex.html.staticControls.supportClasses
private var _down:Boolean;
+ /**
+ * Whether or not the itemRenderer is in a down (or pre-selected) state.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function get down():Boolean
{
return _down;
@@ -133,6 +207,9 @@ package org.apache.flex.html.staticControls.supportClasses
updateRenderer();
}
+ /**
+ * @private
+ */
public function updateRenderer():void
{
if (down)
@@ -143,11 +220,23 @@ package org.apache.flex.html.staticControls.supportClasses
backgroundColor = selectedColor;
}
+ /**
+ * @private
+ */
private function sizeChangeHandler(event:Event):void
{
adjustSize();
}
+ /**
+ * This function is called whenever the itemRenderer changes size. Sub-classes should override
+ * this method an handle the size change.
+ *
+ * @langversion 3.0
+ * @playerversion Flash 10.2
+ * @playerversion AIR 2.6
+ * @productversion FlexJS 0.0
+ */
public function adjustSize():void
{
// handle in subclass