Class JavadocUrlHandler

java.lang.Object

org.fife.rsta.ac.java.JavadocUrlHandler

All Implemented Interfaces:

org.fife.ui.autocomplete.ExternalURLHandler

public class JavadocUrlHandler
extends Object
implements org.fife.ui.autocomplete.ExternalURLHandler

Handles hyperlinks that are clicked in Javadoc for code completions. It's assumed that the links found were created via Util.docCommentToHtml(String), so that things such as "@see" links are interpreted properly.

Version:

1.0

Constructor Summary

Constructors

Constructor	Description
JavadocUrlHandler()

Method Summary

Modifier and Type	Method	Description
private String	doBackups(String pkg, int backupCount)	Returns the parent package backupCount levels up from the package specified.
private static String	getAnchor(String url)	Returns the anchor portion of a (relative) URL.
private static String[]	getArgs(String methodSignature)	Gets the arguments from a method signature.
private String	getClass(org.fife.ui.autocomplete.Completion c, String desc)	Returns the class for a completion (class completions return the class itself, member completions return the enclosing class).
private JavaLanguageSupport	getJavaLanguageSupport()	Returns the Java language support.
private String	getPackage(org.fife.ui.autocomplete.Completion c, String desc)	Returns the package of the specified completion.
private boolean	isRelativeUrl(String text)	Returns whether the text is a relative URL to other Javadoc.
void	urlClicked(HyperlinkEvent e, org.fife.ui.autocomplete.Completion c, org.fife.ui.autocomplete.DescWindowCallback callback)

Methods inherited from class Object

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

Constructor Details

JavadocUrlHandler

public JavadocUrlHandler()

Method Details

doBackups

private String doBackups(String pkg,
 int backupCount)

Returns the parent package backupCount levels up from the package specified.

Parameters:

pkg - A package.

backupCount - The number of packages "up" to go.

Returns:

The parent package.

getJavaLanguageSupport

private JavaLanguageSupport getJavaLanguageSupport()

Returns the Java language support.

Returns:

The Java language support

getAnchor

private static String getAnchor(String url)

Returns the anchor portion of a (relative) URL.

Parameters:

url - The URL.

Returns:

The anchor, or null if none.

getArgs

private static String[] getArgs(String methodSignature)

Gets the arguments from a method signature.

Parameters:

methodSignature - The method signature.

Returns:

The arguments, or an empty array if none.

getClass

private String getClass(org.fife.ui.autocomplete.Completion c,
 String desc)

Returns the class for a completion (class completions return the class itself, member completions return the enclosing class).

getPackage

private String getPackage(org.fife.ui.autocomplete.Completion c,
 String desc)

Returns the package of the specified completion.

Parameters:

c - The completion.

desc - The description text being parsed. Used for errors if we cannot determine the package.

Returns:

The package.

isRelativeUrl

private boolean isRelativeUrl(String text)

Returns whether the text is a relative URL to other Javadoc.

Parameters:

text - A link in Javadoc.

Returns:

Whether the link is a relative path to more Javadoc.

urlClicked

public void urlClicked(HyperlinkEvent e,
 org.fife.ui.autocomplete.Completion c,
 org.fife.ui.autocomplete.DescWindowCallback callback)

Specified by:

urlClicked in interface org.fife.ui.autocomplete.ExternalURLHandler