|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseHyperlink
net.sf.jasperreports.engine.design.JRDesignHyperlink
public class JRDesignHyperlink
Stand-alone implementation of JRHyperlink
which should be used for report design purposes.
| Field Summary | |
|---|---|
static java.lang.String |
PROPERTY_HYPERLINK_ANCHOR_EXPRESSION
|
static java.lang.String |
PROPERTY_HYPERLINK_PAGE_EXPRESSION
|
static java.lang.String |
PROPERTY_HYPERLINK_PARAMETERS
|
static java.lang.String |
PROPERTY_HYPERLINK_REFERENCE_EXPRESSION
|
static java.lang.String |
PROPERTY_HYPERLINK_TARGET
|
static java.lang.String |
PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION
|
static java.lang.String |
PROPERTY_LINK_TARGET
|
static java.lang.String |
PROPERTY_LINK_TYPE
|
| Fields inherited from class net.sf.jasperreports.engine.base.JRBaseHyperlink |
|---|
hyperlinkAnchorExpression, hyperlinkPageExpression, hyperlinkReferenceExpression, hyperlinkTooltipExpression, linkTarget, linkType |
| Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink |
|---|
HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_CUSTOM, HYPERLINK_TARGET_PARENT, HYPERLINK_TARGET_SELF, HYPERLINK_TARGET_TOP, 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. |
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance. |
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)
Deprecated. Replaced by setHyperlinkTarget(HyperlinkTargetEnum). |
void |
setHyperlinkTarget(HyperlinkTargetEnum 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)
Deprecated. Replaced by setHyperlinkType(HyperlinkTypeEnum). |
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type. |
void |
setLinkTarget(java.lang.String target)
Sets the hyperlink target name. |
void |
setLinkType(java.lang.String type)
Sets the hyperlink type. |
| Methods inherited from class net.sf.jasperreports.engine.base.JRBaseHyperlink |
|---|
clone, copyHyperlinkParameters, getHyperlinkAnchorExpression, getHyperlinkPageExpression, getHyperlinkReferenceExpression, getHyperlinkTarget, getHyperlinkTooltipExpression, getHyperlinkType, getHyperlinkTypeValue, getLinkTarget, getLinkType |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_HYPERLINK_ANCHOR_EXPRESSION
public static final java.lang.String PROPERTY_HYPERLINK_PAGE_EXPRESSION
public static final java.lang.String PROPERTY_HYPERLINK_REFERENCE_EXPRESSION
public static final java.lang.String PROPERTY_HYPERLINK_TARGET
public static final java.lang.String PROPERTY_LINK_TARGET
public static final java.lang.String PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION
public static final java.lang.String PROPERTY_LINK_TYPE
public static final java.lang.String PROPERTY_HYPERLINK_PARAMETERS
| Constructor Detail |
|---|
public JRDesignHyperlink()
| Method Detail |
|---|
public void setHyperlinkType(byte hyperlinkType)
setHyperlinkType(HyperlinkTypeEnum).
public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
hyperlinkType - the built-in hyperlink typeJRBaseHyperlink.getLinkType()public void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum).
public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
hyperlinkTarget - the hyperlink target, one of
JRBaseHyperlink.getHyperlinkTarget()public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
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
hyperlinkReferenceExpression - the reference expressionJRBaseHyperlink.getHyperlinkReferenceExpression()public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
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
hyperlinkAnchorExpression - the anchor expressionJRBaseHyperlink.getHyperlinkAnchorExpression()public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
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
hyperlinkPageExpression - the page expressionJRBaseHyperlink.getHyperlinkPageExpression()public void setLinkType(java.lang.String type)
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
type - the hyperlink typepublic void setLinkTarget(java.lang.String target)
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
target - the hyperlink target namepublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkgetHyperlinkParameters in class JRBaseHyperlinkpublic java.util.List getHyperlinkParametersList()
public void addHyperlinkParameter(JRHyperlinkParameter parameter)
parameter - the parameter to addpublic void removeHyperlinkParameter(JRHyperlinkParameter parameter)
parameter - the parameter to removepublic void removeHyperlinkParameter(java.lang.String parameterName)
If multiple parameters having the specified name exist, all of them will be removed
parameterName - the parameter namepublic void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)
java.lang.String.
hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltipJRBaseHyperlink.getHyperlinkTooltipExpression()public JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport in interface JRChangeEventsSupport
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||