Class JRBaseHyperlink
- All Implemented Interfaces:
Serializable
,Cloneable
,JRCloneable
,JRHyperlink
- Direct Known Subclasses:
JRDesignHyperlink
JRHyperlink
.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JRExpression
protected JRExpression
protected JRHyperlinkParameter[]
protected JRExpression
protected JRExpression
protected JRExpression
protected String
protected String
-
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate an empty hyperlink.protected
JRBaseHyperlink
(JRHyperlink link, JRBaseObjectFactory factory) -
Method Summary
Modifier and TypeMethodDescriptionclone()
static JRHyperlinkParameter[]
copyHyperlinkParameters
(JRHyperlink link, JRBaseObjectFactory factory) Returns the expression whose value represents the anchor.Returns an integer representing the page index of the link.Returns the list of hyperlink parameters.Returns the expression whose value represents the hyperlink reference.Retrieves the hyperlink target for the element.Returns the expression which will generate the hyperlink tooltip.Retrieves the hyperlink type for the element.Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.Returns the hyperlink target name.Returns the hyperlink type.
-
Field Details
-
linkType
-
linkTarget
-
hyperlinkReferenceExpression
-
hyperlinkWhenExpression
-
hyperlinkAnchorExpression
-
hyperlinkPageExpression
-
hyperlinkTooltipExpression
-
hyperlinkParameters
-
-
Constructor Details
-
JRBaseHyperlink
public JRBaseHyperlink()Create an empty hyperlink. -
JRBaseHyperlink
-
-
Method Details
-
copyHyperlinkParameters
public static JRHyperlinkParameter[] copyHyperlinkParameters(JRHyperlink link, JRBaseObjectFactory factory) -
getHyperlinkAnchorExpression
Description copied from interface:JRHyperlink
Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.- Specified by:
getHyperlinkAnchorExpression
in interfaceJRHyperlink
-
getHyperlinkPageExpression
Description copied from interface:JRHyperlink
Returns an integer representing the page index of the link. It is only used when the hyperlink type is page. If the expression does not evaluate to an integer, an exception will be thrown.- Specified by:
getHyperlinkPageExpression
in interfaceJRHyperlink
-
getHyperlinkParameters
Description copied from interface:JRHyperlink
Returns the list of hyperlink parameters.The parameters can be used by custom hyperlink types to generate dynamic links.
- Specified by:
getHyperlinkParameters
in interfaceJRHyperlink
- Returns:
- the list of hyperlink parameters
-
getHyperlinkReferenceExpression
Description copied from interface:JRHyperlink
Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor- Specified by:
getHyperlinkReferenceExpression
in interfaceJRHyperlink
-
getHyperlinkWhenExpression
Description copied from interface:JRHyperlink
Returns the expression that is evaluated in order to decide if the hyperlink should be displayed. This expression always returns a boolean value.- Specified by:
getHyperlinkWhenExpression
in interfaceJRHyperlink
-
getHyperlinkTarget
Description copied from interface:JRHyperlink
Retrieves the hyperlink target for the element.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.- Specified by:
getHyperlinkTarget
in interfaceJRHyperlink
- Returns:
- one of the hyperlink target constants
- See Also:
-
getHyperlinkType
Description copied from interface:JRHyperlink
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.- Specified by:
getHyperlinkType
in interfaceJRHyperlink
- Returns:
- one of the hyperlink type constants
- See Also:
-
getLinkType
Description copied from interface:JRHyperlink
Returns the hyperlink type.The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
- Specified by:
getLinkType
in interfaceJRHyperlink
- Returns:
- the hyperlink type
-
getLinkTarget
Description copied from interface:JRHyperlink
Returns the hyperlink target name.The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
- Specified by:
getLinkTarget
in interfaceJRHyperlink
- Returns:
- the hyperlink target name
-
getHyperlinkTooltipExpression
Description copied from interface:JRHyperlink
Returns the expression which will generate the hyperlink tooltip.- Specified by:
getHyperlinkTooltipExpression
in interfaceJRHyperlink
- Returns:
- the expression which will generate the hyperlink tooltip
-
clone
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classObject
-