org.netbeans.spi.io.support

Class Hyperlinks

java.lang.Object

org.netbeans.spi.io.support.Hyperlinks

public final class Hyperlinks
extends Object

Helper class for accessing information from Hyperlink objects.

Method Summary

Modifier and Type	Method and Description
static Intent	getIntent(Hyperlink hyperlink) Get intent associated with a hyperlink of type HyperlinkType.FROM_INTENT.
static Runnable	getRunnable(Hyperlink hyperlink) Get runnable associated with a hyperlink of type HyperlinkType.FROM_RUNNABLE.
static HyperlinkType	getType(Hyperlink hyperlink) Get hyperlink type.
static void	invoke(Hyperlink hyperlink) Invoke appropriate action for the hyperlink.
static boolean	isImportant(Hyperlink hyperlink) Check whether a hyperlink is important.

Methods inherited from class java.lang.Object

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

Method Detail

getType

@NonNull
public static HyperlinkType getType(@NonNull
                                             Hyperlink hyperlink)

Get hyperlink type.

Parameters:

hyperlink - The hyperlink to get type of.

Returns:

The type of the hyperlink.

isImportant

public static boolean isImportant(@NonNull
                                  Hyperlink hyperlink)

Check whether a hyperlink is important.

Important hyperlinks can be printed in different color, or can have some special behavior, e.g. automatic scrolling can be switched off to keep the important hyperlink visible.

Parameters:

hyperlink - The hyperlink to check.

Returns:

True if the hyperlink has been marked as important, false if it is a standard link.

getRunnable

@NonNull
public static Runnable getRunnable(@NonNull
                                            Hyperlink hyperlink)

Get runnable associated with a hyperlink of type HyperlinkType.FROM_RUNNABLE.

Parameters:

hyperlink - The hyperlink to get runnable from.

Returns:

A runnable.

Throws:

IllegalArgumentException - if type of the hyperlink is not HyperlinkType.FROM_RUNNABLE.

See Also:

Hyperlinks.getType(org.netbeans.api.io.Hyperlink), HyperlinkType

getIntent

@NonNull
public static Intent getIntent(@NonNull
                                        Hyperlink hyperlink)

Get intent associated with a hyperlink of type HyperlinkType.FROM_INTENT.

Parameters:

hyperlink - The hyperlink to get intent from.

Returns:

An intent.

Throws:

IllegalArgumentException - if type of the hyperlink is not HyperlinkType.FROM_INTENT.

See Also:

Hyperlinks.getType(org.netbeans.api.io.Hyperlink), HyperlinkType

invoke

public static void invoke(Hyperlink hyperlink)

Invoke appropriate action for the hyperlink.

Parameters:

hyperlink - Hyperlink to invoke.