001: /*
002: * ============================================================================
003: * GNU Lesser General Public License
004: * ============================================================================
005: *
006: * JasperReports - Free Java report-generating library.
007: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
008: *
009: * This library is free software; you can redistribute it and/or
010: * modify it under the terms of the GNU Lesser General Public
011: * License as published by the Free Software Foundation; either
012: * version 2.1 of the License, or (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: * Lesser General Public License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
022: *
023: * JasperSoft Corporation
024: * 303 Second Street, Suite 450 North
025: * San Francisco, CA 94107
026: * http://www.jaspersoft.com
027: */
028: package net.sf.jasperreports.engine;
029:
030: /**
031: * @author Teodor Danciu (teodord@users.sourceforge.net)
032: * @version $Id: JRPrintHyperlink.java 1364 2006-08-31 15:13:20Z lucianc $
033: */
034: public interface JRPrintHyperlink {
035:
036: /**
037: * Retrieves the hyperlink type for the element.
038: * <p>
039: * The actual hyperlink type is determined by {@link #getLinkType() getLinkType()}.
040: * This method can is used to determine whether the hyperlink type is one of the
041: * built-in types or a custom type.
042: * When hyperlink is of custom type, {@link JRHyperlink#HYPERLINK_TYPE_CUSTOM HYPERLINK_TYPE_CUSTOM} is returned.
043: * </p>
044: * @return one of the hyperlink type constants
045: * @see #getLinkType()
046: */
047: public byte getHyperlinkType();
048:
049: /**
050: * Sets the link type as a built-in hyperlink type.
051: *
052: * @param hyperlinkType the built-in hyperlink type
053: * @see #getLinkType()
054: */
055: public void setHyperlinkType(byte hyperlinkType);
056:
057: /**
058: *
059: */
060: public byte getHyperlinkTarget();
061:
062: /**
063: *
064: */
065: public void setHyperlinkTarget(byte hyperlinkTarget);
066:
067: /**
068: *
069: */
070: public String getHyperlinkReference();
071:
072: /**
073: *
074: */
075: public void setHyperlinkReference(String hyperlinkReference);
076:
077: /**
078: *
079: */
080: public String getHyperlinkAnchor();
081:
082: /**
083: *
084: */
085: public void setHyperlinkAnchor(String hyperlinkAnchor);
086:
087: /**
088: *
089: */
090: public Integer getHyperlinkPage();
091:
092: /**
093: *
094: */
095: public void setHyperlinkPage(Integer hyperlinkPage);
096:
097: /**
098: * Returns the hyperlink type.
099: *
100: * @return the hyperlink type
101: */
102: public String getLinkType();
103:
104: /**
105: * Sets the hyperlink type.
106: * <p>
107: * The type can be one of the built-in types
108: * (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage),
109: * or can be an arbitrary type.
110: * </p>
111: * @param type the hyperlink type
112: */
113: public void setLinkType(String type);
114:
115: /**
116: * Returns the set of custom hyperlink parameters.
117: *
118: * @return the set of custom hyperlink parameters
119: * @see #setHyperlinkParameters(JRPrintHyperlinkParameters)
120: * @see JRPrintHyperlinkParameter
121: */
122: public JRPrintHyperlinkParameters getHyperlinkParameters();
123:
124: /**
125: * Sets the custom hyperlink parameters.
126: * <p>
127: * These parameters will be used to produce the actual hyperlink
128: * when the report is exported.
129: * </p>
130: *
131: * @param parameters the set of custom hyperlink parameters
132: */
133: public void setHyperlinkParameters(
134: JRPrintHyperlinkParameters parameters);
135:
136: /**
137: * Returns the hyperlink tooltip.
138: *
139: * @return the hyperlink tooltip
140: */
141: public String getHyperlinkTooltip();
142:
143: /**
144: * Sets the tooltip to be used for the hyperlink.
145: *
146: * @param tooltip the tooltip
147: */
148: public void setHyperlinkTooltip(String tooltip);
149: }
|