org.das2.jythoncompletion.support.CompletionDocumentation

The interface of an item that can be displayed in the documentation popup.

getGotoSourceAction

getGotoSourceAction( ) → javax.swing.Action

Returns an action that opens the item's source representation in the editor or null if the item has no source representation.

Returns:

javax.swing.Action

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getText

getText( ) → String

Returns a HTML text dispaleyd in the documentation popup.

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getURL

getURL( ) → java.net.URL

Returns a URL of the item's external representation that can be displayed in an external browser or null if the item has no external representation.

Returns:

java.net.URL

[search for examples] [view on GitHub] [view on old javadoc] [view source]

resolveLink

resolveLink( String link ) → org.das2.jythoncompletion.support.CompletionDocumentation

Returns a documentation item representing an object linked from the item's HTML text.

Parameters

link - a String

Returns:

org.das2.jythoncompletion.support.CompletionDocumentation

[search for examples] [view on GitHub] [view on old javadoc] [view source]