KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > JRElementGroup


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.engine;
29
30 import java.util.List JavaDoc;
31
32
33 /**
34  * Groups several report elements. Report elements placed in any report section can be arranged in multiple
35  * nested groups. The only reason you might have for grouping your elements is to be able to customize the
36  * stretch behavior of the report elements.
37  * @author Teodor Danciu (teodord@users.sourceforge.net)
38  * @version $Id: JRElementGroup.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
39  */
40 public interface JRElementGroup extends JRChild
41 {
42
43
44     /**
45      * Gets a list of all direct children elements or elements groups.
46      */
47     public List JavaDoc getChildren();
48
49     /**
50      * Gets the parent element group.
51      * @return an instance of this class, or null if this is the root group.
52      */
53     public JRElementGroup getElementGroup();
54
55     /**
56      * Gets an array containing all the elements and element groups in the hierarchy.
57      */
58     public JRElement[] getElements();
59
60
61     /**
62      * Gets an element from this group, based on its element key.
63      */
64     public JRElement getElementByKey(String JavaDoc key);
65
66
67 }
68
Popular Tags