KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > crosstabs > JRCrosstabCell


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.crosstabs;
29
30 /**
31  * Crosstab data cell interface.
32  *
33  * @author Lucian Chirita (lucianc@users.sourceforge.net)
34  * @version $Id: JRCrosstabCell.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
35  * @see net.sf.jasperreports.crosstabs.JRCrosstab#getCells()
36  */
37 public interface JRCrosstabCell
38 {
39     /**
40      * Returns the width of the cell.
41      * <p>
42      * The width of the cell can be unspecified.
43      * The width used for the cell is computed base on the rules described
44      * {@link net.sf.jasperreports.crosstabs.JRCrosstab#getCells() here}.
45      *
46      * @return the width of the cell
47      */
48     public Integer JavaDoc getWidth();
49     
50     
51     /**
52      * Returns the height of the cell.
53      * <p>
54      * The height of the cell can be unspecified.
55      * The height used for the cell is computed base on the rules described
56      * {@link net.sf.jasperreports.crosstabs.JRCrosstab#getCells() here}.
57      *
58      * @return the width of the cell
59      */
60     public Integer JavaDoc getHeight();
61     
62     
63     /**
64      * Returns the name of the row group if the crosstab cell corresponds to a total row
65      * and <code>null</code> otherwise.
66      *
67      * @return the name of the total row group this cell corresponds to
68      */
69     public String JavaDoc getRowTotalGroup();
70     
71     
72     /**
73      * Returns the name of the column group if the crosstab cell corresponds to a total column
74      * and <code>null</code> otherwise.
75      *
76      * @return the name of the total column group this cell corresponds to
77      */
78     public String JavaDoc getColumnTotalGroup();
79     
80     
81     /**
82      * Returns the cell contents.
83      * <p>
84      * Should never return null, but empty cell contents instead.
85      *
86      * @return the cell contents
87      */
88     public JRCellContents getContents();
89 }
90
Popular Tags