KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > krysalis > jcharts > properties > PointChartProperties


1 /***********************************************************************************************
2  * File Info: $Id: PointChartProperties.java,v 1.1 2003/05/17 17:00:36 nathaniel_auvil Exp $
3  * Copyright (C) 2002
4  * Author: Nathaniel G. Auvil
5  * Contributor(s):
6  *
7  * Copyright 2002 (C) Nathaniel G. Auvil. All Rights Reserved.
8  *
9  * Redistribution and use of this software and associated documentation ("Software"), with or
10  * without modification, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain copyright statements and notices.
13  * Redistributions must also contain a copy of this document.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
16  * conditions and the following disclaimer in the documentation and/or other materials
17  * provided with the distribution.
18  *
19  * 3. The name "jCharts" or "Nathaniel G. Auvil" must not be used to endorse or promote
20  * products derived from this Software without prior written permission of Nathaniel G.
21  * Auvil. For written permission, please contact nathaniel_auvil@users.sourceforge.net
22  *
23  * 4. Products derived from this Software may not be called "jCharts" nor may "jCharts" appear
24  * in their names without prior written permission of Nathaniel G. Auvil. jCharts is a
25  * registered trademark of Nathaniel G. Auvil.
26  *
27  * 5. Due credit should be given to the jCharts Project (http://jcharts.sourceforge.net/).
28  *
29  * THIS SOFTWARE IS PROVIDED BY Nathaniel G. Auvil AND CONTRIBUTORS ``AS IS'' AND ANY
30  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * jCharts OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,STRICT LIABILITY, OR TORT
36  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
37  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  ************************************************************************************************/
39
40 package org.krysalis.jcharts.properties;
41
42
43 import org.krysalis.jcharts.chartData.interfaces.IAxisPlotDataSet;
44 import org.krysalis.jcharts.test.HTMLGenerator;
45
46 import java.awt.*;
47 import java.awt.geom.Ellipse2D JavaDoc;
48 import java.awt.geom.Rectangle2D JavaDoc;
49
50
51 final public class PointChartProperties extends AxisChartTypeProperties
52 {
53     public final static Stroke DEFAULT_POINT_BORDER_STROKE = new BasicStroke( 1.0f );
54
55     public final static Shape SHAPE_SQUARE = new Rectangle2D.Double JavaDoc( 0, 0, 10, 10 );
56     public final static Shape SHAPE_TRIANGLE = new Polygon( new int[]{0, 5, 10}, new int[]{10, 0, 10}, 3 );
57     public final static Shape SHAPE_CIRCLE = new Ellipse2D.Double JavaDoc( 0, 0, 10, 10 );
58     public final static Shape SHAPE_DIAMOND = new Polygon( new int[]{0, 5, 10, 5}, new int[]{5, 0, 5, 10}, 4 );
59
60
61     private Shape[] shapes;
62     private boolean[] fillPointFlags;
63     private Paint[] outlinePaints;
64
65
66     /***************************************************************************************************
67      * Constructor
68      *
69      * @param shapes the Shapes to use for each DataSet drawn in this chart. There must
70      * be an one to one mapping of Shape objects and DataSets in the chart.
71      * @param fillPointFlags flags indicating whether to fill the point Shapes or to only outline them
72      * using the Paint specified on the DataSet object. If this is set to TRUE, the 'outlinePaint'
73      * attribute can be used to outline the Shape.
74      * @param outlinePaints Sets the outline Paint to use for each Shape in the chart. This Paint is
75      * only used if the 'setFillPointsFlag' is set to TRUE for the Shape.
76      **************************************************************************************************/
77     public PointChartProperties( Shape[] shapes, boolean[] fillPointFlags, Paint[] outlinePaints )
78     {
79         this.shapes = shapes;
80         this.fillPointFlags = fillPointFlags;
81         this.outlinePaints = outlinePaints;
82     }
83
84
85     /**********************************************************************************************
86      *
87      *
88      ***********************************************************************************************/
89     public boolean getFillPointsFlag( int index )
90     {
91         return this.fillPointFlags[ index ];
92     }
93
94
95     /**********************************************************************************************
96      *
97      *
98      * @param index
99      * @return Paint
100      ***********************************************************************************************/
101     public Paint getPointOutlinePaints( int index )
102     {
103         return this.outlinePaints[ index ];
104     }
105
106
107     /**********************************************************************************************
108      *
109      * @param index
110      * @return Shape
111      ***********************************************************************************************/
112     public Shape getShape( int index )
113     {
114         return this.shapes[ index ];
115     }
116
117
118     /*********************************************************************************************
119      * Enables the testing routines to display the contents of this Object.
120      *
121      * @param htmlGenerator
122      **********************************************************************************************/
123     public void toHTML( HTMLGenerator htmlGenerator )
124     {
125         htmlGenerator.propertiesTableStart( "PointChartProperties" );
126         //htmlGenerator.addTableRow( "Zero Degree Offset", Double.toString( this.getZeroDegreeOffset() ) );
127 htmlGenerator.propertiesTableEnd();
128     }
129
130
131     /******************************************************************************************
132      * Validates the properties.
133      *
134      * @param iAxisPlotDataSet
135      * @throws PropertyException
136      *****************************************************************************************/
137     public void validate( IAxisPlotDataSet iAxisPlotDataSet ) throws PropertyException
138     {
139         if( iAxisPlotDataSet.getNumberOfDataSets() != this.shapes.length )
140         {
141             throw new PropertyException( "<PointChartProperties> There must be a Shape implementation for each data set." );
142         }
143
144         if( this.shapes.length != fillPointFlags.length )
145         {
146             throw new PropertyException( "<PointChartProperties> There is NOT an one to one mapping between 'fillPointsFlags' and Shapes" );
147         }
148
149
150         if( this.shapes.length != outlinePaints.length )
151         {
152             throw new PropertyException( "<PointChartProperties> There is NOT an one to one mapping between 'outlinePaints' and Shapes" );
153         }
154     }
155
156 }
157
Popular Tags