KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > charts > JRChartAxis


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * JasperSoft Corporation
24  * 303 Second Street, Suite 450 North
25  * San Francisco, CA 94107
26  * http://www.jaspersoft.com
27  */
28 package net.sf.jasperreports.charts;
29
30 import net.sf.jasperreports.engine.JRChart;
31
32 /**
33  * Describes an axis that can be added to a multiple axis chart. The name
34  * "axis" is a bit of a misnomer, as it really contains information about
35  * a new dataset to plot, the axis to plot it against, and how to render that
36  * dataset.
37  *
38  * @author Barry Klawans (barry@users.sourceforge.net)
39  * @version $Id: JRChartAxis.java 1400 2006-09-21 10:45:46 +0300 (Thu, 21 Sep 2006) lucianc $
40  */
41
42
43 public interface JRChartAxis
44 {
45     /**
46      * Position the axis to the left of a VERTICAL chart or on the top
47      * of a HORIZONTAL chart.
48      */
49     public static final byte POSITION_LEFT_OR_TOP = 1;
50     
51     /**
52      * Position the axis to the right of a VERTICAL chart or on the bottom
53      * of a HORIZONTAL chart.
54      */
55     public static final byte POSITION_RIGHT_OR_BOTTOM = 2;
56
57     
58     /**
59      * Returns the position of this axis.
60      *
61      * @return the position of this axis
62      */
63     public byte getPosition();
64
65     
66     /**
67      * Returns the chart that contains the dataset and plot to use for this
68      * axis. The plot is used to figure out how to render the dataset when
69      * adding to the multiple axis chart.
70      *
71      * @return the chart that contains the dataset and plot for this axis
72      */
73     public JRChart getChart();
74 }
75
Popular Tags