public class JRBaseHyperlink extends Object implements JRHyperlink, Serializable
JRHyperlink.| Modifier and Type | Field and Description |
|---|---|
protected JRExpression |
hyperlinkAnchorExpression |
protected JRExpression |
hyperlinkPageExpression |
protected JRHyperlinkParameter[] |
hyperlinkParameters |
protected JRExpression |
hyperlinkReferenceExpression |
protected JRExpression |
hyperlinkTooltipExpression |
protected JRExpression |
hyperlinkWhenExpression |
protected String |
linkTarget |
protected String |
linkType |
| Modifier | Constructor and Description |
|---|---|
|
JRBaseHyperlink()
Create an empty hyperlink.
|
protected |
JRBaseHyperlink(JRHyperlink link,
JRBaseObjectFactory factory) |
| Modifier and Type | Method and Description |
|---|---|
Object |
clone() |
static JRHyperlinkParameter[] |
copyHyperlinkParameters(JRHyperlink link,
JRBaseObjectFactory factory) |
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.
|
JRExpression |
getHyperlinkWhenExpression()
Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.
|
String |
getLinkTarget()
Returns the hyperlink target name.
|
String |
getLinkType()
Returns the hyperlink type.
|
protected String linkType
protected String linkTarget
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkWhenExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected JRExpression hyperlinkTooltipExpression
protected JRHyperlinkParameter[] hyperlinkParameters
public JRBaseHyperlink()
protected JRBaseHyperlink(JRHyperlink link, JRBaseObjectFactory factory)
public static JRHyperlinkParameter[] copyHyperlinkParameters(JRHyperlink link, JRBaseObjectFactory factory)
public JRExpression getHyperlinkAnchorExpression()
JRHyperlinkgetHyperlinkAnchorExpression in interface JRHyperlinkpublic JRExpression getHyperlinkPageExpression()
JRHyperlinkgetHyperlinkPageExpression in interface JRHyperlinkpublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkpublic JRExpression getHyperlinkReferenceExpression()
JRHyperlinkgetHyperlinkReferenceExpression in interface JRHyperlinkpublic JRExpression getHyperlinkWhenExpression()
JRHyperlinkgetHyperlinkWhenExpression in interface JRHyperlinkpublic byte getHyperlinkTarget()
JRHyperlink
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, HyperlinkTargetEnum.CUSTOM is returned.
getHyperlinkTarget in interface JRHyperlinkJRHyperlink.getLinkTarget()public byte getHyperlinkType()
getHyperlinkTypeValue().public HyperlinkTypeEnum getHyperlinkTypeValue()
JRHyperlink
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 JRHyperlinkJRHyperlink.getLinkType()public String getLinkType()
JRHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType in interface JRHyperlinkpublic String getLinkTarget()
JRHyperlinkThe type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRHyperlinkpublic JRExpression getHyperlinkTooltipExpression()
JRHyperlinkgetHyperlinkTooltipExpression in interface JRHyperlinkpublic Object clone()
clone in interface JRCloneableclone in class ObjectCopyright © 2017. All rights reserved.