net.sf.jasperreports.engine.design
Class JRDesignHyperlink

java.lang.Object
  extended by net.sf.jasperreports.engine.base.JRBaseHyperlink
      extended by net.sf.jasperreports.engine.design.JRDesignHyperlink
All Implemented Interfaces:
java.io.Serializable, JRHyperlink

public class JRDesignHyperlink
extends JRBaseHyperlink

Stand-alone implementation of JRHyperlink which should be used for report design purposes.

Version:
$Id: JRDesignHyperlink.java 1368 2006-09-01 15:01:52 +0300 (Fri, 01 Sep 2006) lucianc $
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseHyperlink
hyperlinkAnchorExpression, hyperlinkPageExpression, hyperlinkReferenceExpression, hyperlinkTarget, hyperlinkTooltipExpression, linkType
 
Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink
HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_SELF, HYPERLINK_TYPE_CUSTOM, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_NULL, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE
 
Constructor Summary
JRDesignHyperlink()
           
 
Method Summary
 void addHyperlinkParameter(JRHyperlinkParameter parameter)
          Adds a custom hyperlink parameter.
 JRHyperlinkParameter[] getHyperlinkParameters()
          Returns the list of hyperlink parameters.
 java.util.List getHyperlinkParametersList()
          Returns the list of custom hyperlink parameters.
 void removeHyperlinkParameter(JRHyperlinkParameter parameter)
          Removes a custom hyperlink parameter.
 void removeHyperlinkParameter(java.lang.String parameterName)
          Removes a custom hyperlink parameter.
 void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
          Sets the expression that will generate the referred anchor.
 void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
          Sets the expression that will generate the referred page.
 void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
          Sets the expression that will generate the hyperlink reference URL or the referred document location.
 void setHyperlinkTarget(byte hyperlinkTarget)
          Sets the hyperlink target.
 void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
          Sets the expression which will be used to generate the hyperlink tooltip.
 void setHyperlinkType(byte hyperlinkType)
          Sets the link type as a built-in hyperlink type.
 void setLinkType(java.lang.String type)
          Sets the hyperlink type.
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseHyperlink
copyHyperlinkParameters, getHyperlinkAnchorExpression, getHyperlinkPageExpression, getHyperlinkReferenceExpression, getHyperlinkTarget, getHyperlinkTooltipExpression, getHyperlinkType, getLinkType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JRDesignHyperlink

public JRDesignHyperlink()
Method Detail

setHyperlinkType

public void setHyperlinkType(byte hyperlinkType)
Sets the link type as a built-in hyperlink type.

Parameters:
hyperlinkType - the built-in hyperlink type
See Also:
JRBaseHyperlink.getLinkType()

setHyperlinkTarget

public void setHyperlinkTarget(byte hyperlinkTarget)
Sets the hyperlink target.

Parameters:
hyperlinkTarget - the hyperlink target, one of
See Also:
JRBaseHyperlink.getHyperlinkTarget()

setHyperlinkReferenceExpression

public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
Sets the expression that will generate the hyperlink reference URL or the referred document location.

This expression is used when the hyperlink type is JRHyperlink.HYPERLINK_TYPE_REFERENCE, JRHyperlink.HYPERLINK_TYPE_REMOTE_ANCHOR or JRHyperlink.HYPERLINK_TYPE_REMOTE_PAGE. The type of the expression should be java.lang.String

Parameters:
hyperlinkReferenceExpression - the reference expression
See Also:
JRBaseHyperlink.getHyperlinkReferenceExpression()

setHyperlinkAnchorExpression

public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
Sets the expression that will generate the referred anchor.

This expression is used when the hyperlink type is JRHyperlink.HYPERLINK_TYPE_LOCAL_ANCHOR or JRHyperlink.HYPERLINK_TYPE_REMOTE_ANCHOR. The type of the expression should be java.lang.String

Parameters:
hyperlinkAnchorExpression - the anchor expression
See Also:
JRBaseHyperlink.getHyperlinkAnchorExpression()

setHyperlinkPageExpression

public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
Sets the expression that will generate the referred page.

This expression is used when the hyperlink type is JRHyperlink.HYPERLINK_TYPE_LOCAL_PAGE or JRHyperlink.HYPERLINK_TYPE_REMOTE_PAGE. The type of the expression should be java.lang.Integer

Parameters:
hyperlinkPageExpression - the page expression
See Also:
JRBaseHyperlink.getHyperlinkPageExpression()

setLinkType

public void setLinkType(java.lang.String type)
Sets the hyperlink type.

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

Parameters:
type - the hyperlink type

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
Overrides:
getHyperlinkParameters in class JRBaseHyperlink
Returns:
the list of hyperlink parameters

getHyperlinkParametersList

public java.util.List getHyperlinkParametersList()
Returns the list of custom hyperlink parameters.

Returns:
the list of custom hyperlink parameters

addHyperlinkParameter

public void addHyperlinkParameter(JRHyperlinkParameter parameter)
Adds a custom hyperlink parameter.

Parameters:
parameter - the parameter to add

removeHyperlinkParameter

public void removeHyperlinkParameter(JRHyperlinkParameter parameter)
Removes a custom hyperlink parameter.

Parameters:
parameter - the parameter to remove

removeHyperlinkParameter

public void removeHyperlinkParameter(java.lang.String parameterName)
Removes a custom hyperlink parameter.

If multiple parameters having the specified name exist, all of them will be removed

Parameters:
parameterName - the parameter name

setHyperlinkTooltipExpression

public void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
Sets the expression which will be used to generate the hyperlink tooltip. The type of the expression should be java.lang.String.

Parameters:
hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltip
See Also:
JRBaseHyperlink.getHyperlinkTooltipExpression()


© 2001-2006 JasperSoft Corporation www.jaspersoft.com