KickJava   Java API By Example, From Geeks To Geeks.

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


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  * An interface providing anchor functionality. It must be implemented by elements that can contain anchors for
33  * hyperlinks.
34  *
35  * @author Teodor Danciu (teodord@users.sourceforge.net)
36  * @version $Id: JRAnchor.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
37  */
38 public interface JRAnchor
39 {
40     /**
41      * Value of the bookmark level that indicates that no bookmark should be created for the anchor.
42      */
43     public static final int NO_BOOKMARK = 0;
44     
45     /**
46      * Returns an expression whose value represents the anchor name.
47      */
48     public JRExpression getAnchorNameExpression();
49
50     
51     /**
52      * Returns the level of the bookmark corresponding to the anchor.
53      *
54      * @return the level of the bookmark corresponding to the anchor (starting from 1)
55      * or {@link #NO_BOOKMARK NO_BOOKMARK} if no bookmark should be created for this anchor
56      */
57     public int getBookmarkLevel();
58
59 }
60
Popular Tags