KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > design > JRDesignElement


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.design;
29
30 import net.sf.jasperreports.engine.JRConstants;
31 import net.sf.jasperreports.engine.JRDefaultStyleProvider;
32 import net.sf.jasperreports.engine.JRElement;
33 import net.sf.jasperreports.engine.JRElementGroup;
34 import net.sf.jasperreports.engine.JRExpression;
35 import net.sf.jasperreports.engine.JRGroup;
36 import net.sf.jasperreports.engine.JRStyle;
37 import net.sf.jasperreports.engine.base.JRBaseElement;
38
39
40 /**
41  * This class provides a skeleton implementation for a design time report element. The difference between design elements
42  * and compiled elements is that at design time they are more customizable. This class contains setters for properties
43  * that can be only modified at design time.
44  * @author Teodor Danciu (teodord@users.sourceforge.net)
45  * @version $Id: JRDesignElement.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
46  */
47 public abstract class JRDesignElement extends JRBaseElement
48 {
49
50
51     /**
52      *
53      */
54     private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
55
56
57     /**
58      *
59      */
60     protected JRDesignElement(JRDefaultStyleProvider defaultStyleProvider)
61     {
62         super(defaultStyleProvider);
63         
64         positionType = JRElement.POSITION_TYPE_FIX_RELATIVE_TO_TOP;
65     }
66
67
68     /**
69      * Sets the unique identifier for the element.
70      */
71     public void setKey(String JavaDoc key)
72     {
73         this.key = key;
74     }
75         
76     /**
77      * Sets the vertical section relative offset for the element.
78      */
79     public void setY(int y)
80     {
81         this.y = y;
82     }
83     
84     /**
85      *
86      */
87     public void setHeight(int height)
88     {
89         this.height = height;
90     }
91     
92     /**
93      * Sets the print when expression. This expression must always return an instance of <tt>Boolean</tt> and its value
94      * will decide if the element will be displayed.
95      */
96     public void setPrintWhenExpression(JRExpression expression)
97     {
98         this.printWhenExpression = expression;
99     }
100     
101     /**
102      * Specifies the group for which an element with a <i>printRepeatedValues</i> attribute set to true will be redisplayed
103      * even if the value has not changed.
104      */
105     public void setPrintWhenGroupChanges(JRGroup group)
106     {
107         this.printWhenGroupChanges = group;
108     }
109     
110     /**
111      * Specifies the logical group that the element belongs to. More elements can be grouped in order to get the height
112      * of the tallest one.
113      * @see net.sf.jasperreports.engine.JRElement#STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
114      */
115     public void setElementGroup(JRElementGroup elementGroup)
116     {
117         this.elementGroup = elementGroup;
118     }
119     
120     public void setStyle(JRStyle style)
121     {
122         this.parentStyle = style;
123     }
124 }
125
Popular Tags