public class JRBasePrintHyperlink extends Object implements JRPrintHyperlink, Serializable
JRPrintHyperlink.PROPERTY_IGNORE_HYPERLINK_SUFFIX| Constructor and Description |
|---|
JRBasePrintHyperlink()
Creates a blank hyperlink.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addHyperlinkParameter(JRPrintHyperlinkParameter parameter)
Adds a custom hyperlink parameter.
|
String |
getHyperlinkAnchor() |
Integer |
getHyperlinkPage() |
JRPrintHyperlinkParameters |
getHyperlinkParameters()
Returns the set of custom hyperlink parameters.
|
String |
getHyperlinkReference() |
HyperlinkTargetEnum |
getHyperlinkTargetValue() |
String |
getHyperlinkTooltip()
Returns the hyperlink tooltip.
|
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element.
|
String |
getLinkTarget()
Returns the hyperlink target name.
|
String |
getLinkType()
Returns the hyperlink type.
|
void |
setHyperlinkAnchor(String hyperlinkAnchor) |
void |
setHyperlinkPage(Integer hyperlinkPage) |
void |
setHyperlinkParameters(JRPrintHyperlinkParameters parameters)
Sets the custom hyperlink parameters.
|
void |
setHyperlinkReference(String hyperlinkReference) |
void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget) |
void |
setHyperlinkTooltip(String hyperlinkTooltip)
Sets the tooltip to be used for the hyperlink.
|
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type.
|
void |
setLinkTarget(String linkTarget)
Sets the hyperlink target name.
|
void |
setLinkType(String type)
Sets the hyperlink type.
|
public String getHyperlinkAnchor()
getHyperlinkAnchor in interface JRPrintHyperlinkpublic Integer getHyperlinkPage()
getHyperlinkPage in interface JRPrintHyperlinkpublic JRPrintHyperlinkParameters getHyperlinkParameters()
JRPrintHyperlinkgetHyperlinkParameters in interface JRPrintHyperlinkJRPrintHyperlink.setHyperlinkParameters(JRPrintHyperlinkParameters),
JRPrintHyperlinkParameterpublic String getHyperlinkReference()
getHyperlinkReference in interface JRPrintHyperlinkpublic HyperlinkTargetEnum getHyperlinkTargetValue()
getHyperlinkTargetValue in interface JRPrintHyperlinkpublic HyperlinkTypeEnum getHyperlinkTypeValue()
JRPrintHyperlink
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.
getHyperlinkTypeValue in interface JRPrintHyperlinkJRPrintHyperlink.getLinkType()public String getLinkType()
JRPrintHyperlinkgetLinkType in interface JRPrintHyperlinkpublic String getLinkTarget()
JRPrintHyperlinkThe target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRPrintHyperlinkpublic void setHyperlinkAnchor(String hyperlinkAnchor)
setHyperlinkAnchor in interface JRPrintHyperlinkpublic void setHyperlinkPage(Integer hyperlinkPage)
setHyperlinkPage in interface JRPrintHyperlinkpublic void setHyperlinkParameters(JRPrintHyperlinkParameters parameters)
JRPrintHyperlinkThese parameters will be used to produce the actual hyperlink when the report is exported.
setHyperlinkParameters in interface JRPrintHyperlinkparameters - the set of custom hyperlink parameterspublic void setHyperlinkReference(String hyperlinkReference)
setHyperlinkReference in interface JRPrintHyperlinkpublic void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
setHyperlinkTarget in interface JRPrintHyperlinkpublic void setLinkTarget(String linkTarget)
JRPrintHyperlinkThe target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
setLinkTarget in interface JRPrintHyperlinklinkTarget - the hyperlink target namepublic void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
JRPrintHyperlinksetHyperlinkType in interface JRPrintHyperlinkhyperlinkType - the built-in hyperlink typeJRPrintHyperlink.getLinkType()public void setLinkType(String type)
JRPrintHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
setLinkType in interface JRPrintHyperlinktype - the hyperlink typepublic void addHyperlinkParameter(JRPrintHyperlinkParameter parameter)
parameter - the parameter to addgetHyperlinkParameters(),
JRPrintHyperlinkParameters.addParameter(JRPrintHyperlinkParameter)public String getHyperlinkTooltip()
JRPrintHyperlinkgetHyperlinkTooltip in interface JRPrintHyperlinkpublic void setHyperlinkTooltip(String hyperlinkTooltip)
JRPrintHyperlinksetHyperlinkTooltip in interface JRPrintHyperlinkhyperlinkTooltip - the tooltipCopyright © 2017. All rights reserved.