JRPrintHyperlink (JasperReports Library 6.10.0 API)

All Known Subinterfaces:

JRPrintImage, JRPrintText

All Known Implementing Classes:

JRBasePrintHyperlink, JRBasePrintImage, JRBasePrintText, JRRecordedValuesPrintImage, JRRecordedValuesPrintText, JRTemplatePrintImage, JRTemplatePrintText
```
public interface JRPrintHyperlink
```
Author:

Teodor Danciu ([email protected])

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTY_IGNORE_HYPERLINK_SUFFIX` Properties with this suffix are used to specify whether this hyperlink should be ignored at export time

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 tooltip)` 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.

- Field Detail
  - PROPERTY_IGNORE_HYPERLINK_SUFFIX
```
static final String PROPERTY_IGNORE_HYPERLINK_SUFFIX
```
    Properties with this suffix are used to specify whether this hyperlink should be ignored at export time
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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()
  - setHyperlinkType
```
void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
```
    Sets the link type as a built-in hyperlink type.
    
    Parameters:
    
    hyperlinkType - the built-in hyperlink type
    
    See Also:
    
    getLinkType()
  - getHyperlinkTargetValue
```
HyperlinkTargetEnum getHyperlinkTargetValue()
```
  - setHyperlinkTarget
```
void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
```
  - getHyperlinkReference
```
String getHyperlinkReference()
```
  - setHyperlinkReference
```
void setHyperlinkReference(String hyperlinkReference)
```
  - getHyperlinkAnchor
```
String getHyperlinkAnchor()
```
  - setHyperlinkAnchor
```
void setHyperlinkAnchor(String hyperlinkAnchor)
```
  - getHyperlinkPage
```
Integer getHyperlinkPage()
```
  - setHyperlinkPage
```
void setHyperlinkPage(Integer hyperlinkPage)
```
  - getLinkType
```
String getLinkType()
```
    Returns the hyperlink type.
    
    Returns:
    
    the hyperlink type
  - setLinkType
```
void setLinkType(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
```
JRPrintHyperlinkParameters getHyperlinkParameters()
```
    Returns the set of custom hyperlink parameters.
    
    Returns:
    
    the set of custom hyperlink parameters
    
    See Also:
    
    setHyperlinkParameters(JRPrintHyperlinkParameters), JRPrintHyperlinkParameter
  - setHyperlinkParameters
```
void setHyperlinkParameters(JRPrintHyperlinkParameters parameters)
```
    Sets the custom hyperlink parameters.
    These parameters will be used to produce the actual hyperlink when the report is exported.
    
    Parameters:
    
    parameters - the set of custom hyperlink parameters
  - getHyperlinkTooltip
```
String getHyperlinkTooltip()
```
    Returns the hyperlink tooltip.
    
    Returns:
    
    the hyperlink tooltip
  - setHyperlinkTooltip
```
void setHyperlinkTooltip(String tooltip)
```
    Sets the tooltip to be used for the hyperlink.
    
    Parameters:
    
    tooltip - the tooltip
  - getLinkTarget
```
String getLinkTarget()
```
    Returns the hyperlink target name.
    The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
    
    Returns:
    
    the hyperlink type
  - setLinkTarget
```
void setLinkTarget(String linkTarget)
```
    Sets the hyperlink target name.
    The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
    
    Parameters:
    
    linkTarget - the hyperlink target name

Interface JRPrintHyperlink

Field Summary

Method Summary

Field Detail

PROPERTY_IGNORE_HYPERLINK_SUFFIX

Method Detail

getHyperlinkTypeValue

setHyperlinkType

getHyperlinkTargetValue

setHyperlinkTarget

getHyperlinkReference

setHyperlinkReference

getHyperlinkAnchor

setHyperlinkAnchor

getHyperlinkPage

setHyperlinkPage

getLinkType

setLinkType

getHyperlinkParameters

setHyperlinkParameters

getHyperlinkTooltip

setHyperlinkTooltip

getLinkTarget

setLinkTarget