net.sf.jasperreports.engine
Class JRHyperlinkHelper

java.lang.Object
  net.sf.jasperreports.engine.JRHyperlinkHelper

public class JRHyperlinkHelper
extends java.lang.Object

Utility class that manages built-in hyperlink types.

Version:

$Id: JRHyperlinkHelper.java 3033 2009-08-27 11:46:22Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

static java.lang.String	HYPERLINK_TARGET_BLANK "Blank" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_BLANK.
static java.lang.String	HYPERLINK_TARGET_PARENT "Parent" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_PARENT.
static java.lang.String	HYPERLINK_TARGET_SELF "Self" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_SELF.
static java.lang.String	HYPERLINK_TARGET_TOP "Top" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_TOP.
static java.lang.String	HYPERLINK_TYPE_LOCAL_ANCHOR "LocalAnchor" link type, equivalent to JRHyperlink.HYPERLINK_LOCAL_ANCHOR.
static java.lang.String	HYPERLINK_TYPE_LOCAL_PAGE "LocalPage" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_LOCAL_PAGE.
static java.lang.String	HYPERLINK_TYPE_NONE "None" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_NONE.
static java.lang.String	HYPERLINK_TYPE_REFERENCE "Reference" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_REFERENCE.
static java.lang.String	HYPERLINK_TYPE_REMOTE_ANCHOR "RemoteAnchor" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_REMOTE_ANCHOR.
static java.lang.String	HYPERLINK_TYPE_REMOTE_PAGE "RemotePage" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_REMOTE_PAGE.

Constructor Summary

JRHyperlinkHelper()

Method Summary

static byte	getHyperlinkTarget(JRHyperlink hyperlink) Returns the built-in hyperlink target, or JRHyperlink.HYPERLINK_TARGET_CUSTOM if the target name is not a built-in one.
static byte	getHyperlinkTarget(java.lang.String linkTarget) Returns the built-in hyperlink target, or JRHyperlink.HYPERLINK_TARGET_CUSTOM if the target name is not a built-in one.
static byte	getHyperlinkType(JRHyperlink hyperlink) Returns the built-in hyperlink type, or JRHyperlink.HYPERLINK_TYPE_CUSTOM if the type is not a built-in type.
static byte	getHyperlinkType(java.lang.String linkType) Returns the built-in hyperlink type, or JRHyperlink.HYPERLINK_TYPE_CUSTOM if the type is not a built-in type.
static java.lang.String	getLinkTarget(byte hyperlinkTarget) Returns the link target associated with a built-in target.
static java.lang.String	getLinkType(byte hyperlinkType) Returns the link type associated with a built-in type.
static boolean	isEmpty(JRHyperlink hyperlink) Decides whether a hyperlink is empty or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HYPERLINK_TYPE_NONE

public static final java.lang.String HYPERLINK_TYPE_NONE

"None" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_NONE.

See Also:

Constant Field Values

HYPERLINK_TYPE_REFERENCE

public static final java.lang.String HYPERLINK_TYPE_REFERENCE

"Reference" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_REFERENCE.

See Also:

Constant Field Values

HYPERLINK_TYPE_LOCAL_ANCHOR

public static final java.lang.String HYPERLINK_TYPE_LOCAL_ANCHOR

"LocalAnchor" link type, equivalent to JRHyperlink.HYPERLINK_LOCAL_ANCHOR.

See Also:

Constant Field Values

HYPERLINK_TYPE_LOCAL_PAGE

public static final java.lang.String HYPERLINK_TYPE_LOCAL_PAGE

"LocalPage" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_LOCAL_PAGE.

See Also:

Constant Field Values

HYPERLINK_TYPE_REMOTE_ANCHOR

public static final java.lang.String HYPERLINK_TYPE_REMOTE_ANCHOR

"RemoteAnchor" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_REMOTE_ANCHOR.

See Also:

Constant Field Values

HYPERLINK_TYPE_REMOTE_PAGE

public static final java.lang.String HYPERLINK_TYPE_REMOTE_PAGE

"RemotePage" link type, equivalent to JRHyperlink.HYPERLINK_TYPE_REMOTE_PAGE.

See Also:

Constant Field Values

HYPERLINK_TARGET_SELF

public static final java.lang.String HYPERLINK_TARGET_SELF

"Self" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_SELF.

See Also:

Constant Field Values

HYPERLINK_TARGET_BLANK

public static final java.lang.String HYPERLINK_TARGET_BLANK

"Blank" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_BLANK.

See Also:

Constant Field Values

HYPERLINK_TARGET_PARENT

public static final java.lang.String HYPERLINK_TARGET_PARENT

"Parent" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_PARENT.

See Also:

Constant Field Values

HYPERLINK_TARGET_TOP

public static final java.lang.String HYPERLINK_TARGET_TOP

"Top" link target name, equivalent to JRHyperlink.HYPERLINK_TARGET_TOP.

See Also:

Constant Field Values

Constructor Detail

JRHyperlinkHelper

public JRHyperlinkHelper()

Method Detail

getHyperlinkType

public static byte getHyperlinkType(JRHyperlink hyperlink)

Returns the built-in hyperlink type, or JRHyperlink.HYPERLINK_TYPE_CUSTOM if the type is not a built-in type.

Parameters:

hyperlink - the hyperlink object

Returns:

the hyperlink type

getHyperlinkType

public static byte getHyperlinkType(java.lang.String linkType)

Returns the built-in hyperlink type, or JRHyperlink.HYPERLINK_TYPE_CUSTOM if the type is not a built-in type.

Parameters:

linkType - the link type

Returns:

the hyperlink type

getHyperlinkTarget

public static byte getHyperlinkTarget(JRHyperlink hyperlink)

Returns the built-in hyperlink target, or JRHyperlink.HYPERLINK_TARGET_CUSTOM if the target name is not a built-in one.

Parameters:

hyperlink - the hyperlink object

Returns:

the hyperlink target

getHyperlinkTarget

public static byte getHyperlinkTarget(java.lang.String linkTarget)

Returns the built-in hyperlink target, or JRHyperlink.HYPERLINK_TARGET_CUSTOM if the target name is not a built-in one.

Parameters:

linkTarget - the link target type

Returns:

the hyperlink target

getLinkType

public static java.lang.String getLinkType(byte hyperlinkType)

Returns the link type associated with a built-in type.

Parameters:

hyperlinkType - the built-in type

Returns:

the String link type

getLinkTarget

public static java.lang.String getLinkTarget(byte hyperlinkTarget)

Returns the link target associated with a built-in target.

Parameters:

hyperlinkTarget - the built-in target type

Returns:

the String link target

isEmpty

public static boolean isEmpty(JRHyperlink hyperlink)

Decides whether a hyperlink is empty or not.

The hyperlink is considered empty when it's null or when its type is HYPERLINK_TYPE_NONE and it doesn't include a tooltip expression

Parameters:

hyperlink - the hyperlink

Returns:

whether the hyperlink is empty