Editor Hints
Under Development

See:
Description

Editor Hints

org.netbeans.spi.editor.hints

.

EditorHintsSPI allows to show errors in the editor, with possible fixes.

What is New (see all changes)?

• Feb 24 '10 Added ErrorDescriptionFactory.attachSubfixes

  Added a new method ErrorDescriptionFactory.attachSubfixes that allows to attach sub-fixes to given fix.

• Jul 20 '09 Added PositionRefresher interface and Context

  Added new interface and context class in order to be able to provide up-to-date hints on current line.

Use Cases

redunderline

Assume that you have a module using e.g. Parsing API to parse the source files and wants to mark the errors in the editor to be shown as red underlined in the editor. Here is the pseudo code that achieves this:

Document doc = ...;
ArrayList<ErrorDescription> errors = new ArrayList<ErrorDescription>();
for (<all errors from the parser that have parsed the doc>) {
    errors.add(
        ErrorDescriptionFactory.createErrorDescription(
            Severity.ERROR,
            d.getMessage(Locale.getDefault()),
            doc,
            doc.createPosition(start),
            doc.createPosition(end)
        )
    );
}
HintsController.setErrors(doc, "myerrors", errors);

warningwithfix

Adding a warning with fixes:

static final class FixImpl implements Fix {
...
}
...
Document doc = ...;
List<Fix> fixes = Arrays.<Fix>asList(new FixImpl(...));
ArrayList<ErrorDescription> warnings = new ArrayList<ErrorDescription>();
for (<all places where the warning should be displayed>) {
    warnings.add(
        ErrorDescriptionFactory.createErrorDescription(
            Severity.WARNING,
            displayName,
            fixes,
            doc,
            doc.createPosition(start),
            doc.createPosition(end)
        )
    );
}
HintsController.setErrors(doc, "mywarnings", warnings);

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
EditorHintsSPI	Exported	Under Development	.../spi/editor/hints/package-summary.html allows to show errors in the editor, with possible fixes.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Normal module dependencies are used for this module.

Read more about the implementation in the answers to architecture questions.