|
| |
|
| net.sf.jasperreports.engine.JRHyperlink
All known Subclasses: net.sf.jasperreports.engine.base.JRBaseHyperlink,
| JRHyperlink | | public interface JRHyperlink (Code) | | An interface providing hyperlink functionality. It must be implemented by elements that can contain hyperlinks.
There are three types of hyperlinks: reference, anchor and page. The reference type just points to an external resource.
The anchor type can point to an anchor in the current document or inside an external referenced document. In the latter
case, users have to specify both an anchor expression and a reference expression. The page type can point to the
beginning of a specific page in the current document or an external document (in the same way that anchor type does).
See Also: JRAnchor
author:
Teodor Danciu (teodord@users.sourceforge.net)
version:
$Id: JRHyperlink.java 1364 2006-08-31 15:13:20Z lucianc $ |
| Field Summary | |
| final public static byte | HYPERLINK_TARGET_BLANK
Constant useful for specifying that the hyperlink will be opened in a new window. | | final public static byte | HYPERLINK_TARGET_SELF
Constant useful for specifying that the hyperlink will be opened in the same window. | | final public static byte | HYPERLINK_TYPE_CUSTOM
Custom hyperlink type. | | final public static byte | HYPERLINK_TYPE_LOCAL_ANCHOR
Constant useful for specifying that the hyperlink points to a local anchor, specified by the hyperlink
anchor expression. | | final public static byte | HYPERLINK_TYPE_LOCAL_PAGE
Constant useful for specifying that the hyperlink points to a 1 based page index within the current document. | | final public static byte | HYPERLINK_TYPE_NONE
Constant useful for specifying that the element does not contain a hyperlink. | | final public static byte | HYPERLINK_TYPE_NULL
Not set hyperlink type. | | final public static byte | HYPERLINK_TYPE_REFERENCE
Constant useful for specifying that the hyperlink points to an external resource specified by the
hyperlink reference expression. | | final public static byte | HYPERLINK_TYPE_REMOTE_ANCHOR
Constant useful for specifying that the hyperlink points to a remote anchor (specified by the hyperlink
anchor expression) within an external document (specified by the hyperlink reference expression). | | final public static byte | HYPERLINK_TYPE_REMOTE_PAGE
Constant useful for specifying that the hyperlink points to a 1 based page index within an external document
(specified by the hyperlink reference expression). |
| HYPERLINK_TARGET_BLANK | | final public static byte HYPERLINK_TARGET_BLANK(Code) | | Constant useful for specifying that the hyperlink will be opened in a new window.
|
| HYPERLINK_TARGET_SELF | | final public static byte HYPERLINK_TARGET_SELF(Code) | | Constant useful for specifying that the hyperlink will be opened in the same window.
|
| HYPERLINK_TYPE_CUSTOM | | final public static byte HYPERLINK_TYPE_CUSTOM(Code) | | Custom hyperlink type.
The specific type is determined by
JRHyperlink.getLinkType() getLinkType() .
|
| HYPERLINK_TYPE_LOCAL_ANCHOR | | final public static byte HYPERLINK_TYPE_LOCAL_ANCHOR(Code) | | Constant useful for specifying that the hyperlink points to a local anchor, specified by the hyperlink
anchor expression.
See Also: JRHyperlink.getHyperlinkAnchorExpression |
| HYPERLINK_TYPE_LOCAL_PAGE | | final public static byte HYPERLINK_TYPE_LOCAL_PAGE(Code) | | Constant useful for specifying that the hyperlink points to a 1 based page index within the current document.
|
| HYPERLINK_TYPE_NONE | | final public static byte HYPERLINK_TYPE_NONE(Code) | | Constant useful for specifying that the element does not contain a hyperlink. This is the default value
for a hyperlink type.
|
| HYPERLINK_TYPE_NULL | | final public static byte HYPERLINK_TYPE_NULL(Code) | | Not set hyperlink type.
|
| HYPERLINK_TYPE_REFERENCE | | final public static byte HYPERLINK_TYPE_REFERENCE(Code) | | Constant useful for specifying that the hyperlink points to an external resource specified by the
hyperlink reference expression.
See Also: JRHyperlink.getHyperlinkReferenceExpression |
| HYPERLINK_TYPE_REMOTE_PAGE | | final public static byte HYPERLINK_TYPE_REMOTE_PAGE(Code) | | Constant useful for specifying that the hyperlink points to a 1 based page index within an external document
(specified by the hyperlink reference expression).
|
| getHyperlinkAnchorExpression | | public JRExpression getHyperlinkAnchorExpression()(Code) | | Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.
|
| getHyperlinkPageExpression | | public JRExpression getHyperlinkPageExpression()(Code) | | 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.
|
| getHyperlinkParameters | | public JRHyperlinkParameter[] getHyperlinkParameters()(Code) | | Returns the list of hyperlink parameters.
The parameters can be used by custom hyperlink types to generate
dynamic links.
the list of hyperlink parameters |
| getHyperlinkReferenceExpression | | public JRExpression getHyperlinkReferenceExpression()(Code) | | Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is
reference or anchor
|
| getHyperlinkTarget | | public byte getHyperlinkTarget()(Code) | | Retrieves the hyperlink target for the element.
one of the hyperlink target constants |
| getHyperlinkTooltipExpression | | public JRExpression getHyperlinkTooltipExpression()(Code) | | Returns the expression which will generate the hyperlink tooltip.
the expression which will generate the hyperlink tooltip |
| getHyperlinkType | | public byte getHyperlinkType()(Code) | | Retrieves the hyperlink type for the element.
The actual hyperlink type is determined by
JRHyperlink.getLinkType() 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,
JRHyperlink.HYPERLINK_TYPE_CUSTOM HYPERLINK_TYPE_CUSTOM is returned.
one of the hyperlink type constants
See Also: JRHyperlink.getLinkType() |
| getLinkType | | public String getLinkType()(Code) | | 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.
the hyperlink type |
|
|
|