Package net.sf.jasperreports.engine.base

Class JRBaseHyperlink

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseHyperlink

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, JRCloneable, JRHyperlink

Direct Known Subclasses:

JRDesignHyperlink

public class JRBaseHyperlink
extends java.lang.Object
implements JRHyperlink, java.io.Serializable

Read-only implementation of JRHyperlink.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRExpression	hyperlinkAnchorExpression
protected JRExpression	hyperlinkPageExpression
protected JRHyperlinkParameter[]	hyperlinkParameters
protected JRExpression	hyperlinkReferenceExpression
protected JRExpression	hyperlinkTooltipExpression
protected JRExpression	hyperlinkWhenExpression
protected java.lang.String	linkTarget
protected java.lang.String	linkType

Constructor Summary

Constructors

Modifier	Constructor	Description
	JRBaseHyperlink()	Create an empty hyperlink.
protected	JRBaseHyperlink(JRHyperlink link, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
static JRHyperlinkParameter[]	copyHyperlinkParameters(JRHyperlink link, JRBaseObjectFactory factory)
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()	Deprecated. Replaced by getHyperlinkTypeValue().
HyperlinkTargetEnum	getHyperlinkTargetValue()	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.
java.lang.String	getLinkTarget()	Returns the hyperlink target name.
java.lang.String	getLinkType()	Returns the hyperlink type.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

linkType

protected java.lang.String linkType

linkTarget

protected java.lang.String linkTarget

hyperlinkReferenceExpression

protected JRExpression hyperlinkReferenceExpression

hyperlinkWhenExpression

protected JRExpression hyperlinkWhenExpression

hyperlinkAnchorExpression

protected JRExpression hyperlinkAnchorExpression

hyperlinkPageExpression

protected JRExpression hyperlinkPageExpression

hyperlinkTooltipExpression

protected JRExpression hyperlinkTooltipExpression

hyperlinkParameters

protected JRHyperlinkParameter[] hyperlinkParameters

Constructor Detail

JRBaseHyperlink

public JRBaseHyperlink()

Create an empty hyperlink.

JRBaseHyperlink

protected JRBaseHyperlink(JRHyperlink link,
                          JRBaseObjectFactory factory)

Method Detail

copyHyperlinkParameters

public static JRHyperlinkParameter[] copyHyperlinkParameters(JRHyperlink link,
                                                             JRBaseObjectFactory factory)

getHyperlinkAnchorExpression

public JRExpression getHyperlinkAnchorExpression()

Description copied from interface: JRHyperlink

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

Specified by:

getHyperlinkAnchorExpression in interface JRHyperlink

getHyperlinkPageExpression

public JRExpression getHyperlinkPageExpression()

Description copied from interface: JRHyperlink

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.

Specified by:

getHyperlinkPageExpression in interface JRHyperlink

getHyperlinkParameters

public JRHyperlinkParameter[] getHyperlinkParameters()

Description copied from interface: JRHyperlink

Returns the list of hyperlink parameters.

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

Specified by:

getHyperlinkParameters in interface JRHyperlink

Returns:

the list of hyperlink parameters

getHyperlinkReferenceExpression

public JRExpression getHyperlinkReferenceExpression()

Description copied from interface: JRHyperlink

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

Specified by:

getHyperlinkReferenceExpression in interface JRHyperlink

getHyperlinkWhenExpression

public JRExpression getHyperlinkWhenExpression()

Description copied from interface: JRHyperlink

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

Specified by:

getHyperlinkWhenExpression in interface JRHyperlink

getHyperlinkTarget

public byte getHyperlinkTarget()

Deprecated.

Replaced by getHyperlinkTypeValue().

Specified by:

getHyperlinkTarget in interface JRHyperlink

getHyperlinkTargetValue

public HyperlinkTargetEnum getHyperlinkTargetValue()

Description copied from interface: JRHyperlink

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.

Specified by:

getHyperlinkTargetValue in interface JRHyperlink

Returns:

one of the hyperlink target constants

See Also:

JRHyperlink.getLinkTarget()

getHyperlinkType

public byte getHyperlinkType()

Deprecated.

Replaced by getHyperlinkTypeValue().

getHyperlinkTypeValue

public HyperlinkTypeEnum getHyperlinkTypeValue()

Description copied from interface: JRHyperlink

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.

Specified by:

getHyperlinkTypeValue in interface JRHyperlink

Returns:

one of the hyperlink type constants

See Also:

JRHyperlink.getLinkType()

getLinkType

public java.lang.String getLinkType()

Description copied from interface: JRHyperlink

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.

Specified by:

getLinkType in interface JRHyperlink

Returns:

the hyperlink type

getLinkTarget

public java.lang.String getLinkTarget()

Description copied from interface: JRHyperlink

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.

Specified by:

getLinkTarget in interface JRHyperlink

Returns:

the hyperlink target name

getHyperlinkTooltipExpression

public JRExpression getHyperlinkTooltipExpression()

Description copied from interface: JRHyperlink

Returns the expression which will generate the hyperlink tooltip.

Specified by:

getHyperlinkTooltipExpression in interface JRHyperlink

Returns:

the expression which will generate the hyperlink tooltip

clone

public java.lang.Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class java.lang.Object