Introduction

This document lists changes made to the Editor Hints SPI.


Index of APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.spi.editor.hints/0 > 1.20

Changes by affected class

org.netbeans.spi.editor.hints.Context

org.netbeans.spi.editor.hints.ErrorDescriptionFactory

org.netbeans.spi.editor.hints.settings.FileHintPreferences

org.netbeans.spi.editor.hints.PositionRefresher


Details of all changes by API and date


Editor Hints

Provide a way to have fixable annotation with default action

Jul 24 '17; API spec. version: 1.43.0; made by: mromashova; issues: #271069
For custom type of annotations will dynamically register this annotation type as fixable, so Fix action (click on the icon) will work for it

Support multiple ranges for ErrorDescriptor

Jul 17 '17; API spec. version: 1.42.0; made by: mromashova; issues: #271070
Added support for multiple ranges for error/warning. New field added to ErrorDescription as well as corresponding getter method and new constructor in order to be able to provide multiple ranges support for highlight particular hint. Added new factory method to ErrorDescriptionFactory which uses new ErrorDescription constructor.

Added customType field and constructor to ErrorDescription

Aug 26 '15; API spec. version: 1.38.0; made by: danilasergeyev; issues: #254375
Added customType field to ErrorDescription as well as corresponding getter method and new constructor in order to be able to provide custom annotation type for particular hint. Added new factory method to ErrorDescriptionFactory which uses new ErrorDescription constructor.

Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds

Apr 24 '13; API spec. version: 1.31; affected top-level classes: FileHintPreferences; made by: jlahoda; issues: #212326
XXX

Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds

May 17 '12; API spec. version: 1.24; affected top-level classes: ErrorDescriptionFactory; made by: jlahoda; issues: #212326
Added several a new variant of ErrorDescriptionFactory.createErrorDescription taking PositionBounds to specify the span of the error/warning.

Added id and details to ErrorDescriptionFactory.createErrorDescription

Mar 19 '12; API spec. version: 1.22; affected top-level classes: ErrorDescriptionFactory; made by: jlahoda; issues: #209448
Added several new variants of ErrorDescriptionFactory.createErrorDescription. These new variants allow to specify an optional error/warning id and more details.

Added ErrorDescriptionFactory.attachSubfixes

Feb 24 '10; API spec. version: 1.13; affected top-level classes: ErrorDescriptionFactory; made by: jlahoda; issues: #180724
Added a new method ErrorDescriptionFactory.attachSubfixes that allows to attach sub-fixes to given fix.

Added PositionRefresher interface and Context

Jul 20 '09; API spec. version: 1.8.1; affected top-level classes: PositionRefresher Context; made by: msauer
Added new interface and context class in order to be able to provide up-to-date hints on current line.

Built on October 23 2017.  |  Portions Copyright 1997-2017 Oracle. All rights reserved.