CompletionDocumentation (NetBeans Editor Code Completion SPI) - NetBeans API Javadoc 5.5.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.completion/1 1.6.22

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.editor.completion
Interface CompletionDocumentation

public interface CompletionDocumentation

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

Method Summary

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

String getText()
          Returns a HTML text dispaleyd in the documentation popup.

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

Method Summary
`Action`	`getGotoSourceAction()` Returns an action that opens the item's source representation in the editor or `null` if the item has no source representation.
`String`	`getText()` Returns a HTML text dispaleyd in the documentation popup.
`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(String link)` Returns a documentation item representing an object linked from the item's HTML text.

Method Detail

getText

String getText()

Returns a HTML text dispaleyd in the documentation popup.

getURL

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(String link)

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

getGotoSourceAction

Action getGotoSourceAction()

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