net.sf.jasperreports.engine

Interface JRHyperlink

All Superinterfaces:

Cloneable, JRCloneable

All Known Subinterfaces:

ChartSettings, JRChart, JRImage, JRTextField

All Known Implementing Classes:

FillChartSettings, JRBaseChart, JRBaseHyperlink, JRBaseImage, JRBaseTextField, JRDesignChart, JRDesignHyperlink, JRDesignImage, JRDesignTextField, JRFillChart, JRFillImage, JRFillTextField, StandardChartSettings

public interface JRHyperlink
extends JRCloneable

An interface providing hyperlink functionality. It must be implemented by elements that can contain hyperlinks. There are three types of hyperlinks: reference, anchor and page. The reference type just points to an external resource. The anchor type can point to an anchor in the current document or inside an external referenced document. In the latter case, users have to specify both an anchor expression and a reference expression. The page type can point to the beginning of a specific page in the current document or an external document (in the same way that anchor type does).

Version:

$Id: JRHyperlink.java 5912 2013-01-31 14:50:33Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

JRAnchor

Method Summary

Methods

Modifier and Type	Method and Description
JRExpression	getHyperlinkAnchorExpression() Returns the expression whose value represents the anchor.
JRExpression	getHyperlinkPageExpression() Returns an integer representing the page index of the link.
JRHyperlinkParameter[]	getHyperlinkParameters() Returns the list of hyperlink parameters.
JRExpression	getHyperlinkReferenceExpression() Returns the expression whose value represents the hyperlink reference.
byte	getHyperlinkTarget() Retrieves the hyperlink target for the element.
JRExpression	getHyperlinkTooltipExpression() Returns the expression which will generate the hyperlink tooltip.
byte	getHyperlinkType() Deprecated. Replaced by getHyperlinkTypeValue().
HyperlinkTypeEnum	getHyperlinkTypeValue() Retrieves the hyperlink type for the element.
JRExpression	getHyperlinkWhenExpression() Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.
String	getLinkTarget() Returns the hyperlink target name.
String	getLinkType() Returns the hyperlink type.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Method Detail

getHyperlinkType

byte getHyperlinkType()

Deprecated. Replaced by getHyperlinkTypeValue().

getHyperlinkTypeValue

HyperlinkTypeEnum getHyperlinkTypeValue()

Retrieves the hyperlink type for the element.

The actual hyperlink type is determined by getLinkType(). This method can is used to determine whether the hyperlink type is one of the built-in types or a custom type. When hyperlink is of custom type, CUSTOM is returned.

Returns:

one of the hyperlink type constants

See Also:

getLinkType()

getHyperlinkTarget

byte getHyperlinkTarget()

Retrieves the hyperlink target for the element.

The actual hyperlink target is determined by getLinkTarget(). This method can is used to determine whether the hyperlink target is one of the built-in target names or a custom one. When hyperlink has a custom target name, HyperlinkTargetEnum.CUSTOM is returned.

Returns:

one of the hyperlink target constants

See Also:

getLinkTarget()

getHyperlinkReferenceExpression

JRExpression getHyperlinkReferenceExpression()

Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor

getHyperlinkWhenExpression

JRExpression getHyperlinkWhenExpression()

Returns the expression that is evaluated in order to decide if the hyperlink should be displayed. This expression always returns a boolean value.

getHyperlinkAnchorExpression

JRExpression getHyperlinkAnchorExpression()

Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.

getHyperlinkPageExpression

JRExpression getHyperlinkPageExpression()

Returns an integer representing the page index of the link. It is only used when the hyperlink type is page. If the expression does not evaluate to an integer, an exception will be thrown.

getLinkType

String getLinkType()

Returns the hyperlink type.

The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

Returns:

the hyperlink type

getLinkTarget

String getLinkTarget()

Returns the hyperlink target name.

The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.

Returns:

the hyperlink target name

getHyperlinkParameters

JRHyperlinkParameter[] getHyperlinkParameters()

Returns the list of hyperlink parameters.

The parameters can be used by custom hyperlink types to generate dynamic links.

Returns:

the list of hyperlink parameters

getHyperlinkTooltipExpression

JRExpression getHyperlinkTooltipExpression()

Returns the expression which will generate the hyperlink tooltip.

Returns:

the expression which will generate the hyperlink tooltip