org.netbeans.modules.editor.errorstripe.api/1 2.29.1 1

Editor Error Stripe
Stable

The Error Stripe gathers the information to show from three sources:

  • (A subset of) editor annotations. See TextAPIOpenIDE Text API for more details.
  • Up-to-date status providers. This is the ErrorStripeSPIpublic SPI provided by the Error Stripe. The Up-to-date status provides affects the "global" status view in the Error Stripe.
  • ErrorStripePrivateSPIPrivate mark provider SPI.

What is New (see all changes)?

Use Cases

Augment Annotations to be shown in the Error Stripe
Use the OpenIDE Text API.
Provide Up-to-date Status for the Error Stripe

A module in the IDE has information whether data shown in the Error Stripe is up-to-date or not. The Error Stripe may change the appearance according to this knowledge.

Implement the UpToDateStatusProvider that provides up-to-date status. Be sure that it fires PropertyChangeEvent when this status is changed.

Implement the UpToDateStatusProviderFactory that creates an instance of your UpToDateStatusProvider for a given JTextComponent and install it as described here.

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 NameIn/OutStabilitySpecified in What Document?
TextAPIExportedStable../org-openide-text/overview-summary.html

OpenIDE Text API

../org-openide-text/overview-summary.html

OpenIDE Text API

ErrorStripeSPIExportedStableindex.html

public SPI provided by the Error Stripe.

index.html

Error Stripe SPI

ErrorStripePrivateSPIExportedPrivate

Private mark provider SPI.

private mark provider SPI.

private mark provider SPI

private mark provider SPI.

private mark provider SPI

Group of systemproperty interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.netbeans.modules.editor.errorstripe.AnnotationViewExportedPrivate

This property sets the logging level. See org.openide.ErrorManager.getInstance for more details.

Implementation Details

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

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

org.netbeans.modules.editor.errorstripe.api/1 2.29.1 1

Built on August 25 2014.  |  Portions Copyright 1997-2014 Oracle. All rights reserved.