|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRHyperlink
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).
JRAnchor
Field Summary | |
---|---|
static byte |
HYPERLINK_TARGET_BLANK
Constant useful for specifying that the hyperlink will be opened in a new window. |
static byte |
HYPERLINK_TARGET_CUSTOM
Custom hyperlink target name. |
static byte |
HYPERLINK_TARGET_PARENT
Constant useful for specifying that the hyperlink will be opened in the parent frame. |
static byte |
HYPERLINK_TARGET_SELF
Constant useful for specifying that the hyperlink will be opened in the same window. |
static byte |
HYPERLINK_TARGET_TOP
Constant useful for specifying that the hyperlink will be opened in the top frame. |
static byte |
HYPERLINK_TYPE_CUSTOM
Custom hyperlink type. |
static byte |
HYPERLINK_TYPE_LOCAL_ANCHOR
Constant useful for specifying that the hyperlink points to a local anchor, specified by the hyperlink anchor expression. |
static byte |
HYPERLINK_TYPE_LOCAL_PAGE
Constant useful for specifying that the hyperlink points to a 1 based page index within the current document. |
static byte |
HYPERLINK_TYPE_NONE
Constant useful for specifying that the element does not contain a hyperlink. |
static byte |
HYPERLINK_TYPE_NULL
Not set hyperlink type. |
static byte |
HYPERLINK_TYPE_REFERENCE
Constant useful for specifying that the hyperlink points to an external resource specified by the hyperlink reference expression. |
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). |
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). |
Method Summary | |
---|---|
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()
Retrieves the hyperlink type for the element. |
java.lang.String |
getLinkTarget()
Returns the hyperlink target name. |
java.lang.String |
getLinkType()
Returns the hyperlink type. |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Field Detail |
---|
static final byte HYPERLINK_TYPE_NONE
static final byte HYPERLINK_TYPE_REFERENCE
getHyperlinkReferenceExpression()
,
Constant Field Valuesstatic final byte HYPERLINK_TYPE_LOCAL_ANCHOR
getHyperlinkAnchorExpression()
,
Constant Field Valuesstatic final byte HYPERLINK_TYPE_LOCAL_PAGE
static final byte HYPERLINK_TYPE_REMOTE_ANCHOR
getHyperlinkAnchorExpression()
,
getHyperlinkReferenceExpression()
,
Constant Field Valuesstatic final byte HYPERLINK_TYPE_REMOTE_PAGE
static final byte HYPERLINK_TYPE_NULL
static final byte HYPERLINK_TYPE_CUSTOM
The specific type is determined by getLinkType()
.
static final byte HYPERLINK_TARGET_SELF
static final byte HYPERLINK_TARGET_BLANK
static final byte HYPERLINK_TARGET_PARENT
static final byte HYPERLINK_TARGET_TOP
static final byte HYPERLINK_TARGET_CUSTOM
The specific target name is determined by getLinkTarget()
.
Method Detail |
---|
byte getHyperlinkType()
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, HYPERLINK_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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |