flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From p...@apache.org
Subject git commit: [flex-asjs] [refs/heads/develop] - asdoc for the chart package and BarChart component.
Date Mon, 03 Feb 2014 16:15:49 GMT
Updated Branches:
  refs/heads/develop 709d4d313 -> 57e8bdfb8


asdoc for the chart package and BarChart component.


Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/57e8bdfb
Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/57e8bdfb
Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/57e8bdfb

Branch: refs/heads/develop
Commit: 57e8bdfb807758e17d8e96e4560853f77c363d5e
Parents: 709d4d3
Author: Peter Ent <pent@apache.org>
Authored: Mon Feb 3 11:15:40 2014 -0500
Committer: Peter Ent <pent@apache.org>
Committed: Mon Feb 3 11:15:40 2014 -0500

----------------------------------------------------------------------
 .../src/org/apache/flex/charts/BarChart.as      | 27 +++++++
 .../apache/flex/charts/beads/BarChartView.as    | 13 ++++
 .../charts/beads/ChartItemRendererFactory.as    | 29 ++++++++
 .../org/apache/flex/charts/beads/XAxisBead.as   | 25 +++++++
 .../flex/charts/beads/layouts/BarChartLayout.as | 25 +++++++
 .../src/org/apache/flex/charts/core/IChart.as   | 22 ++++++
 .../org/apache/flex/charts/core/IChartAxis.as   |  9 +++
 .../flex/charts/core/IChartItemRenderer.as      | 75 ++++++++++++++++++++
 .../org/apache/flex/charts/core/IChartSeries.as | 43 +++++++++++
 .../charts/supportClasses/BarChartSeries.as     | 52 ++++++++++++++
 .../charts/supportClasses/BoxItemRenderer.as    | 74 +++++++++++++++++--
 11 files changed, 388 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/BarChart.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/BarChart.as b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/BarChart.as
index eef195c..78e413e 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/BarChart.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/BarChart.as
@@ -22,13 +22,40 @@ package org.apache.flex.charts
 	import org.apache.flex.events.Event;
 	import org.apache.flex.html.staticControls.List;
 	
+	/**
+	 *  The BarChart class draws a multi-series graph of data using vertical
+	 *  columns. The series property is an array of BarChartSeries instances
+	 *  that represent the data in the model.
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class BarChart extends List implements IChart
 	{
+		/**
+		 *  constructor.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		public function BarChart()
 		{
 			super();
 		}
 		
+		/**
+		 *  The collection of series for the chart. Each element of the
+		 *  series array should be of type BarChartSeries.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _series:Array;
 		public function get series():Array
 		{

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/BarChartView.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/BarChartView.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/BarChartView.as
index 1dd9b0e..23f747a 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/BarChartView.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/BarChartView.as
@@ -22,6 +22,16 @@ package org.apache.flex.charts.beads
 	import org.apache.flex.core.IStrand;
 	import org.apache.flex.html.staticControls.beads.ListView;
 	
+	/**
+	 *  The BarChartView class is the visual bead for a BarChart. This class makes
+	 *  sure all of the necessary parts to make a BarChart are instantiated.
+	 *   
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class BarChartView extends ListView
 	{
 		public function BarChartView()
@@ -32,6 +42,9 @@ package org.apache.flex.charts.beads
 		private var _strand:IStrand;
 		private var listModel:ISelectionModel;
 		
+		/**
+		 * @private
+		 */
 		override public function set strand(value:IStrand):void
 		{
 			_strand = value;

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/ChartItemRendererFactory.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/ChartItemRendererFactory.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/ChartItemRendererFactory.as
index fc6f07b..e842fa9 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/ChartItemRendererFactory.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/ChartItemRendererFactory.as
@@ -31,6 +31,18 @@ package org.apache.flex.charts.beads
 	import org.apache.flex.events.IEventDispatcher;
 	import org.apache.flex.html.staticControls.beads.IListView;
 	
+	/**
+	 *  The ChartItemRendererFactory class implements IDataProviderItemRendererMapper
+	 *  and creats the itemRenderers for each series in a chart. The itemRenderer class
+	 *  is identified on each series either through a property or through a CSS style.
+	 *  Once all of the itemRenderers are created, an itemsCreated event is dispatched
+	 *  causing the layout associated with the chart to size and position the items. 
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class ChartItemRendererFactory implements IBead, IDataProviderItemRendererMapper
 	{
 		public function ChartItemRendererFactory()
@@ -40,6 +52,14 @@ package org.apache.flex.charts.beads
 		private var selectionModel:ISelectionModel;
 		protected var dataGroup:IItemRendererParent;
 		
+		/**
+		 *  The array of renderers created for each series.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _seriesRenderers:Array;
 		public function get seriesRenderers():Array
 		{
@@ -48,6 +68,9 @@ package org.apache.flex.charts.beads
 		
 		private var _strand:IStrand;
 		
+		/**
+		 * @private
+		 */
 		public function set strand(value:IStrand):void
 		{
 			_strand = value;
@@ -91,11 +114,17 @@ package org.apache.flex.charts.beads
 			IEventDispatcher(_strand).dispatchEvent(new Event("itemsCreated"));
 		}
 		
+		/**
+		 * @private
+		 */
 		public function get itemRendererFactory():IItemRendererClassFactory
 		{
 			return null;
 		}
 		
+		/**
+		 * @private
+		 */
 		public function set itemRendererFactory(value:IItemRendererClassFactory):void
 		{
 		}

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/XAxisBead.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/XAxisBead.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/XAxisBead.as
index 342d2b9..15e9c73 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/XAxisBead.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/XAxisBead.as
@@ -31,12 +31,31 @@ package org.apache.flex.charts.beads
 	import org.apache.flex.html.staticControls.Label;
 	import org.apache.flex.html.staticControls.beads.models.ArraySelectionModel;
 	
+	/**
+	 *  The BoxItemRenderer displays a colored rectangular area suitable for use as
+	 *  an itemRenderer for a BarChartSeries. This class implements the IChartItemRenderer
+	 *  interface. 
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class XAxisBead implements IBead, IChartAxis
 	{
 		public function XAxisBead()
 		{
 		}
 		
+		/**
+		 *  The name of field witin the chart data to use to label each of the
+		 *  axis data points.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _labelField:String;
 		public function get labelField():String
 		{
@@ -47,6 +66,9 @@ package org.apache.flex.charts.beads
 			_labelField = value;
 		}
 		
+		/**
+		 * @private
+		 */
 		private var _strand:IStrand;
 		public function set strand(value:IStrand):void
 		{
@@ -56,6 +78,9 @@ package org.apache.flex.charts.beads
 			IEventDispatcher(_strand).addEventListener("layoutComplete",handleItemsCreated);
 		}
 		
+		/**
+		 * @private
+		 */
 		private function handleItemsCreated(event:Event):void
 		{
 			var charter:ChartItemRendererFactory =

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/layouts/BarChartLayout.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/layouts/BarChartLayout.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/layouts/BarChartLayout.as
index a61e12c..80c369e 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/layouts/BarChartLayout.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/beads/layouts/BarChartLayout.as
@@ -30,10 +30,22 @@ package org.apache.flex.charts.beads.layouts
 	import org.apache.flex.charts.core.IChartItemRenderer;
 	import org.apache.flex.charts.supportClasses.BarChartSeries;
 	
+	/**
+	 *  The BarChartLayout class calculates the size and position of all of the itemRenderers
for
+	 *  all of the series in a BarChart. 
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class BarChartLayout implements IBeadLayout
 	{
 		private var _strand:IStrand;
 		
+		/**
+		 * @private
+		 */
 		public function set strand(value:IStrand):void
 		{
 			_strand = value;
@@ -42,6 +54,16 @@ package org.apache.flex.charts.beads.layouts
 			IEventDispatcher(value).addEventListener("itemsCreated", changeHandler);
 		}
 		
+		/**
+		 *  The amount of space to leave between series. If a chart has several series,
+		 *  the bars for an X value are side by side with a gap between the groups of
+		 *  bars.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _gap:Number = 20;
 		public function get gap():Number
 		{
@@ -52,6 +74,9 @@ package org.apache.flex.charts.beads.layouts
 			_gap = 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/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChart.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChart.as b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChart.as
index 9b10dd6..ac8d530 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChart.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChart.as
@@ -18,8 +18,30 @@
 ////////////////////////////////////////////////////////////////////////////////
 package org.apache.flex.charts.core
 {
+	/**
+	 *  The IChart interface is the basic interface for every chart component. All
+	 *  charts have a least one "series" - a collection of data values for each
+	 *  axis of the chart (a PieChart follows this pattern, too, since the total
+	 *  number of items in its series represents 100% of the pie and each item
+	 *  contributes some percentage). A Chart then uses a set of beads particular
+	 *  to that chart type.
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public interface IChart
 	{
+		/**
+		 *  The collection of series for the chart. Each element of the
+		 *  series array should be of type IChartSeries.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get series():Array;
 		function set series(value:Array):void;
 	}

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartAxis.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartAxis.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartAxis.as
index d36f5ec..a10b12e 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartAxis.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartAxis.as
@@ -18,6 +18,15 @@
 ////////////////////////////////////////////////////////////////////////////////
 package org.apache.flex.charts.core
 {
+	/**
+	 *  The IChartAxis interface is a marker for any class that draws an axis
+	 *  for a chart. The XAxisBead is an example that implements this interface.
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public interface IChartAxis
 	{
 		

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartItemRenderer.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartItemRenderer.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartItemRenderer.as
index 01bf1aa..af6603d 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartItemRenderer.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartItemRenderer.as
@@ -20,20 +20,95 @@ package org.apache.flex.charts.core
 {
 	import org.apache.flex.core.IItemRenderer;
 	
+	/**
+	 *  The IChartItemRenderer interface is the interface implemented by any
+	 *  class that draws chart graphics.
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public interface IChartItemRenderer extends IItemRenderer
 	{
+		/**
+		 *  The name of the field containing the X-axis value found
+		 *  in the data property.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get xField():String;
 		function set xField(value:String):void;
 		
+		/**
+		 *  The name of the field containing the Y-axis value found
+		 *  in the data property.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get yField():String;
 		function set yField(value:String):void;
 		
+		/**
+		 *  The primary or preferred color to use for the graphics for
+		 *  the type of chart.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get fillColor():uint;
 		function set fillColor(value:uint):void;
 		
+		/**
+		 *  The x display position for the itemRenderer. This is set by
+		 *  the chart's layout manager.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function set x(value:Number):void;
+		
+		/**
+		 *  The y display position for the itemRenderer. This is set by
+		 *  the chart's layout manager.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function set y(value:Number):void;
+		
+		/**
+		 *  The display width for the itemRenderer. This is set by
+		 *  the chart's layout manager.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function set width(value:Number):void;
+		
+		/**
+		 *  The display height for the itemRenderer. This is set by
+		 *  the chart's layout manager.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function set height(value:Number):void;
 	}
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartSeries.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartSeries.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartSeries.as
index bb0dc45..43e8e66 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartSeries.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/core/IChartSeries.as
@@ -20,17 +20,60 @@ package org.apache.flex.charts.core
 {
 	import mx.core.IFactory;
 
+	/**
+	 *  The IChartSeries interface is the basic interface for any type of
+	 *  chart data series. 
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public interface IChartSeries
 	{
+		/**
+		 *  The name field that represents the X-axis value for the chart series.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get xField():String;
 		function set xField(value:String):void;
 		
+		/**
+		 *  The name field that represents the Y-axis value for the chart series.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get yField():String;
 		function set yField(value:String):void;
 		
+		/**
+		 *  The preferred color to use for the series renderer.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get fillColor():uint;
 		function set fillColor(value:uint):void;
 		
+		/**
+		 *  The itemRenderer class or factory that produces an instance of that class. This
+		 *  renderer uses the series data and properties to draw the representation for the
+		 *  chart type (e.g., the BarChart draws a bar in the fillColor).
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		function get itemRenderer():IFactory;
 		function set itemRenderer(value:IFactory):void;
 	}

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BarChartSeries.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BarChartSeries.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BarChartSeries.as
index 99040be..0d47237 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BarChartSeries.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BarChartSeries.as
@@ -22,12 +22,38 @@ package org.apache.flex.charts.supportClasses
     
 	import org.apache.flex.charts.core.IChartSeries;
 	
+	/**
+	 *  The BarChartSeries represents a pair of X and Y values to be drawn
+	 *  within a BarChart. 
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class BarChartSeries implements IChartSeries
 	{
+		/**
+		 *  constructor.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		public function BarChartSeries()
 		{
 		}
 		
+		/**
+		 *  The name of the field corresponding to the X or horizontal value
+		 *  for an item in the chart. 
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _xField:String = "x";
 		public function get xField():String
 		{
@@ -38,6 +64,15 @@ package org.apache.flex.charts.supportClasses
 			_xField = value;
 		}
 		
+		/**
+		 *  The name of the field that provides the Y or vertical value for an
+		 *  item in the chart.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _yField:String;
 		public function get yField():String
 		{
@@ -48,6 +83,14 @@ package org.apache.flex.charts.supportClasses
 			_yField = value;
 		}
 		
+		/**
+		 *  The color to use for all bars in the series.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _fillColor:uint;
 		public function get fillColor():uint
 		{
@@ -58,6 +101,15 @@ package org.apache.flex.charts.supportClasses
 			_fillColor = value;
 		}
 		
+		/**
+		 *  The class or class factory to use as the itemRenderer for each X/Y pair. The
+		 *  itemRenderer class must implement the IChartItemRenderer interface.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _itemRenderer:IFactory;
 		public function get itemRenderer():IFactory
 		{

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/57e8bdfb/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BoxItemRenderer.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BoxItemRenderer.as
b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BoxItemRenderer.as
index 2df2565..05bbdd0 100644
--- a/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BoxItemRenderer.as
+++ b/frameworks/as/projects/FlexJSJX/src/org/apache/flex/charts/supportClasses/BoxItemRenderer.as
@@ -19,17 +19,43 @@
 package org.apache.flex.charts.supportClasses
 {
 	import org.apache.flex.core.FilledRectangle;
-	import org.apache.flex.core.IItemRenderer;
 	import org.apache.flex.html.staticControls.supportClasses.UIItemRendererBase;
 	import org.apache.flex.charts.core.IChartItemRenderer;
 	
+	/**
+	 *  The BoxItemRenderer displays a colored rectangular area suitable for use as
+	 *  an itemRenderer for a BarChartSeries. This class implements the IChartItemRenderer
+	 *  interface. 
+	 *  
+	 *  @langversion 3.0
+	 *  @playerversion Flash 10.2
+	 *  @playerversion AIR 2.6
+	 *  @productversion FlexJS 0.0
+	 */
 	public class BoxItemRenderer extends UIItemRendererBase implements IChartItemRenderer
 	{
+		/**
+		 *  constructor.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		public function BoxItemRenderer()
 		{
 			super();
 		}
 				
+		/**
+		 *  The parent component of the itemRenderer instance. This is the container that houses
+		 *  all of the itemRenderers for the series.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _itemRendererParent:Object;
 		public function get itemRendererParent():Object
 		{
@@ -42,6 +68,14 @@ package org.apache.flex.charts.supportClasses
 		
 		private var filledRect:FilledRectangle;
 		
+		/**
+		 *  The name of the field containing the value for the Y axis.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _yField:String = "y";
 		public function get yField():String
 		{
@@ -52,6 +86,14 @@ package org.apache.flex.charts.supportClasses
 			_yField = value;
 		}
 		
+		/**
+		 *  The name of the field containing the value for the X axis.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _xField:String = "x";
 		public function get xField():String
 		{
@@ -62,6 +104,14 @@ package org.apache.flex.charts.supportClasses
 			_xField = value;
 		}
 		
+		/**
+		 *  The color used to fill the interior of the box.
+		 *
+		 *  @langversion 3.0
+		 *  @playerversion Flash 10.2
+		 *  @playerversion AIR 2.6
+		 *  @productversion FlexJS 0.0
+		 */
 		private var _fillColor:uint;
 		public function get fillColor():uint
 		{
@@ -72,11 +122,14 @@ package org.apache.flex.charts.supportClasses
 			_fillColor = value;
 		}
 		
-		override public function addedToParent():void
-		{
-			super.addedToParent();
-		}
-		
+		/**
+		 *  The data being represented.
+		 *
+		 *  @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;		
@@ -87,18 +140,27 @@ package org.apache.flex.charts.supportClasses
 			}	
 		}
 		
+		/**
+		 *  @private
+		 */
 		override public function set width(value:Number):void
 		{
 			super.width = value;
 			drawBar();
 		}
 		
+		/**
+		 *  @private
+		 */
 		override public function set height(value:Number):void
 		{
 			super.height = value;
 			drawBar();
 		}
 		
+		/**
+		 *  @private
+		 */
 		protected function drawBar():void
 		{
 			if (filledRect) {


Mime
View raw message