org.das2.jythoncompletion

Class DefaultDocumentationItem

java.lang.Object

org.das2.jythoncompletion.DefaultDocumentationItem

All Implemented Interfaces:

CompletionDocumentation

public class DefaultDocumentationItem
extends java.lang.Object
implements CompletionDocumentation

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentationItem(java.lang.String link)
DefaultDocumentationItem(java.lang.String link, java.lang.String text)

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 string) Returns a documentation item representing an object linked from the item's HTML text.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDocumentationItem

public DefaultDocumentationItem(java.lang.String link)

DefaultDocumentationItem

public DefaultDocumentationItem(java.lang.String link,
                                java.lang.String text)

Method Detail

getText

public java.lang.String getText()

Description copied from interface: CompletionDocumentation

Returns a HTML text dispaleyd in the documentation popup.

Specified by:

getText in interface CompletionDocumentation

getURL

public java.net.URL getURL()

Description copied from interface: CompletionDocumentation

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.

Specified by:

getURL in interface CompletionDocumentation

resolveLink

public CompletionDocumentation resolveLink(java.lang.String string)

Description copied from interface: CompletionDocumentation

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

Specified by:

resolveLink in interface CompletionDocumentation

getGotoSourceAction

public javax.swing.Action getGotoSourceAction()

Description copied from interface: CompletionDocumentation

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

Specified by:

getGotoSourceAction in interface CompletionDocumentation