KickJava   Java API By Example, From Geeks To Geeks.

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


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
31 /**
32  * @author Teodor Danciu (teodord@users.sourceforge.net)
33  * @version $Id: JRPrintHyperlink.java 1364 2006-08-31 18:13:20 +0300 (Thu, 31 Aug 2006) lucianc $
34  */
35 public interface JRPrintHyperlink
36 {
37
38
39
40
41     /**
42      * Retrieves the hyperlink type for the element.
43      * <p>
44      * The actual hyperlink type is determined by {@link #getLinkType() getLinkType()}.
45      * This method can is used to determine whether the hyperlink type is one of the
46      * built-in types or a custom type.
47      * When hyperlink is of custom type, {@link JRHyperlink#HYPERLINK_TYPE_CUSTOM HYPERLINK_TYPE_CUSTOM} is returned.
48      * </p>
49      * @return one of the hyperlink type constants
50      * @see #getLinkType()
51      */
52     public byte getHyperlinkType();
53
54     
55     /**
56      * Sets the link type as a built-in hyperlink type.
57      *
58      * @param hyperlinkType the built-in hyperlink type
59      * @see #getLinkType()
60      */
61     public void setHyperlinkType(byte hyperlinkType);
62         
63     /**
64      *
65      */
66     public byte getHyperlinkTarget();
67         
68     /**
69      *
70      */
71     public void setHyperlinkTarget(byte hyperlinkTarget);
72         
73     /**
74      *
75      */
76     public String JavaDoc getHyperlinkReference();
77         
78     /**
79      *
80      */
81     public void setHyperlinkReference(String JavaDoc hyperlinkReference);
82
83     /**
84      *
85      */
86     public String JavaDoc getHyperlinkAnchor();
87         
88     /**
89      *
90      */
91     public void setHyperlinkAnchor(String JavaDoc hyperlinkAnchor);
92
93     /**
94      *
95      */
96     public Integer JavaDoc getHyperlinkPage();
97         
98     /**
99      *
100      */
101     public void setHyperlinkPage(Integer JavaDoc hyperlinkPage);
102
103     
104     /**
105      * Returns the hyperlink type.
106      *
107      * @return the hyperlink type
108      */
109     public String JavaDoc getLinkType();
110     
111     
112     /**
113      * Sets the hyperlink type.
114      * <p>
115      * The type can be one of the built-in types
116      * (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage),
117      * or can be an arbitrary type.
118      * </p>
119      * @param type the hyperlink type
120      */
121     public void setLinkType(String JavaDoc type);
122
123     
124     /**
125      * Returns the set of custom hyperlink parameters.
126      *
127      * @return the set of custom hyperlink parameters
128      * @see #setHyperlinkParameters(JRPrintHyperlinkParameters)
129      * @see JRPrintHyperlinkParameter
130      */
131     public JRPrintHyperlinkParameters getHyperlinkParameters();
132     
133
134     /**
135      * Sets the custom hyperlink parameters.
136      * <p>
137      * These parameters will be used to produce the actual hyperlink
138      * when the report is exported.
139      * </p>
140      *
141      * @param parameters the set of custom hyperlink parameters
142      */
143     public void setHyperlinkParameters(JRPrintHyperlinkParameters parameters);
144
145     
146     /**
147      * Returns the hyperlink tooltip.
148      *
149      * @return the hyperlink tooltip
150      */
151     public String JavaDoc getHyperlinkTooltip();
152     
153     
154     /**
155      * Sets the tooltip to be used for the hyperlink.
156      *
157      * @param tooltip the tooltip
158      */
159     public void setHyperlinkTooltip(String JavaDoc tooltip);
160 }
161
Popular Tags