com.f1j.ss
Interface Hyperlink

public interface Hyperlink

extends Lockable

This class represents a Hyperlink.

Hyperlinking is supported on all Windows platforms. Hyperlinks may be added to a cell or range of cells. Support is included for links to absolute and relative ranges within the same or an external workbook, links to absolute or relative URLs (launches a browser), links to absolute or relative file location (supports any registered format), and links to e-mail (using the mailto: command).

Field Summary

static int	kFileAbs The type of link is to an absolute file.
static int	kFileRel The type of link is to a relative file.
static int	kNet The type of link is to network file.
static int	kRange The type of link is to a range.
static int	kUnknown The type of link is unknown.
static int	kURLAbs The type of link is to an absolute URL.
static int	kURLRel The type of link is to an relative URL (Reserved).

Method Summary

java.lang.String	getLinkString() Returns the hyperlink link string.
java.lang.String	getRange() Returns the range to which this hyperlink applies.
java.lang.String	getToolTipString() Returns the tool tip string.
int	getType() Returns the current hyperlink type.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Field Detail

kUnknown

public static final int kUnknown

The type of link is unknown.

kRange

public static final int kRange

The type of link is to a range.

kURLAbs

public static final int kURLAbs

The type of link is to an absolute URL.

kURLRel

public static final int kURLRel

The type of link is to an relative URL (Reserved).

kFileAbs

public static final int kFileAbs

The type of link is to an absolute file.

kFileRel

public static final int kFileRel

The type of link is to a relative file.

kNet

public static final int kNet

The type of link is to network file.

Method Detail

getType

public int getType()

Returns the current hyperlink type.

Returns:

an int indicating one of the following hyperlink types:

Valid Hyperlink Types

kUnknown	kRange	kURLAbs
kURLRel	kFileAbs	kFileRel	kNet

getLinkString

public java.lang.String getLinkString()

Returns the hyperlink link string.

Returns:

a string that is the link

getToolTipString

public java.lang.String getToolTipString()

Returns the tool tip string.

Returns:

the tool tip as a string.

getRange

public java.lang.String getRange()

Returns the range to which this hyperlink applies.

Returns:

a string containing the range reference.