public interface JRHyperlink extends JRCloneable
JRAnchor
Modifier and Type | Method and Description |
---|---|
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()
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.
|
java.lang.String |
getLinkTarget()
Returns the hyperlink target name.
|
java.lang.String |
getLinkType()
Returns the hyperlink type.
|
clone
static final byte HYPERLINK_TYPE_NONE
HyperlinkTypeEnum.NONE
.static final byte HYPERLINK_TYPE_REFERENCE
HyperlinkTypeEnum.REFERENCE
.static final byte HYPERLINK_TYPE_LOCAL_ANCHOR
HyperlinkTypeEnum.LOCAL_ANCHOR
.static final byte HYPERLINK_TYPE_LOCAL_PAGE
HyperlinkTypeEnum.LOCAL_PAGE
.static final byte HYPERLINK_TYPE_REMOTE_ANCHOR
HyperlinkTypeEnum.REMOTE_ANCHOR
.static final byte HYPERLINK_TYPE_REMOTE_PAGE
HyperlinkTypeEnum.REMOTE_PAGE
.static final byte HYPERLINK_TYPE_NULL
HyperlinkTypeEnum.NULL
.static final byte HYPERLINK_TYPE_CUSTOM
HyperlinkTypeEnum.CUSTOM
.
The specific type is determined by getLinkType()
.
static final byte HYPERLINK_TARGET_SELF
HyperlinkTargetEnum.SELF
.static final byte HYPERLINK_TARGET_BLANK
HyperlinkTargetEnum.BLANK
.static final byte HYPERLINK_TARGET_PARENT
HyperlinkTargetEnum.PARENT
.static final byte HYPERLINK_TARGET_TOP
HyperlinkTargetEnum.TOP
.static final byte HYPERLINK_TARGET_CUSTOM
HyperlinkTargetEnum.CUSTOM
.
The specific target name is determined by getLinkTarget()
.
byte getHyperlinkType()
getHyperlinkTypeValue()
.HyperlinkTypeEnum getHyperlinkTypeValue()
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.
getLinkType()
byte getHyperlinkTarget()
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, HYPERLINK_TYPE_CUSTOM
is returned.
getLinkTarget()
JRExpression getHyperlinkReferenceExpression()
JRExpression getHyperlinkAnchorExpression()
JRExpression getHyperlinkPageExpression()
java.lang.String getLinkType()
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
java.lang.String getLinkTarget()
The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
JRHyperlinkParameter[] getHyperlinkParameters()
The parameters can be used by custom hyperlink types to generate dynamic links.
JRExpression getHyperlinkTooltipExpression()
© 2001-2010 Jaspersoft Corporation www.jaspersoft.com