org.das2.jythoncompletion.support

Interface CompletionDocumentation

All Known Implementing Classes:

DefaultDocumentationItem

public interface CompletionDocumentation

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

Method Summary

Modifier and Type	Method and Description
javax.swing.Action	getGotoSourceAction() Returns an action that opens the item's source representation in the editor or null if the item has no source representation.
java.lang.String	getText() Returns a HTML text dispaleyd in the documentation popup.
java.net.URL	getURL() 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.
CompletionDocumentation	resolveLink(java.lang.String link) Returns a documentation item representing an object linked from the item's HTML text.

Method Detail

getText

java.lang.String getText()

Returns a HTML text dispaleyd in the documentation popup.

getURL

java.net.URL getURL()

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.

resolveLink

CompletionDocumentation resolveLink(java.lang.String link)

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

getGotoSourceAction

javax.swing.Action getGotoSourceAction()

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