| <html> |
| <!-- Generated from apichanges.xml --> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Change History for the Editor Hints SPI</title> |
| |
| <link rel="stylesheet" href="prose.css" type="text/css"> |
| |
| </head> |
| |
| <body> |
| |
| |
| <p class="overviewlink"> |
| <a href="overview-summary.html" shape="rect">Overview</a> |
| </p> |
| |
| |
| <h1>Introduction</h1> |
| |
| |
| <p>This document lists changes made to the <a href="overview-summary.html" shape="rect">Editor Hints SPI</a>.</p> |
| |
| <!-- The actual lists of changes, as summaries and details: --> |
| |
| <hr> |
| |
| <h1> |
| <a name="list-all-apis">Index of APIs</a> |
| </h1> |
| <ul> |
| <li> |
| <a href="#EditorHintsSPI">Editor Hints</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="incompat-by-date">Incompatible changes by date</a> |
| </h1> |
| <p>Fuller descriptions of all changes can be found below (follow links).</p> |
| <p>Not all deprecations are listed here, assuming that the deprecated |
| APIs continue to essentially work. For a full deprecation list, please |
| consult the |
| <a href="deprecated-list.html">Javadoc</a>.</p> |
| <ul></ul> |
| <h1> |
| <a name="all-by-date">All changes by date</a> |
| </h1> |
| <ul> |
| <li>(Jul 24 '17) <a href="#fixable-annotation-default-action">Provide a way to have fixable annotation with default action</a> |
| </li> |
| <li>(Jul 17 '17) <a href="#multiple-annotation-type">Support multiple ranges for ErrorDescriptor</a> |
| </li> |
| <li>(Aug 26 '15) <a href="#custom-annotation-type">Added customType field and constructor to ErrorDescription</a> |
| </li> |
| <li>(Apr 24 '13) <a href="#per-project-hints">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </li> |
| <li>(May 17 '12) <a href="#error-description-from-position-bounds">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </li> |
| <li>(Mar 19 '12) <a href="#id-and-details">Added id and details to ErrorDescriptionFactory.createErrorDescription</a> |
| </li> |
| <li>(Feb 24 '10) <a href="#attachSubfixes">Added ErrorDescriptionFactory.attachSubfixes</a> |
| </li> |
| <li>(Jul 20 '09) <a href="#Refreshers">Added PositionRefresher interface and Context</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-version">Changes by version</a> |
| </h1> |
| <p> |
| 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 <samp>1.20</samp>, your |
| manifest should contain in its main attributes the line: |
| </p> |
| <pre>OpenIDE-Module-Module-Dependencies: org.netbeans.spi.editor.hints/0 > 1.20</pre> |
| <ul> |
| <li> |
| (1.43.0) <a href="#fixable-annotation-default-action">Provide a way to have fixable annotation with default action</a> |
| </li> |
| <li> |
| (1.42.0) <a href="#multiple-annotation-type">Support multiple ranges for ErrorDescriptor</a> |
| </li> |
| <li> |
| (1.38.0) <a href="#custom-annotation-type">Added customType field and constructor to ErrorDescription</a> |
| </li> |
| <li> |
| (1.31) <a href="#per-project-hints">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </li> |
| <li> |
| (1.24) <a href="#error-description-from-position-bounds">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </li> |
| <li> |
| (1.22) <a href="#id-and-details">Added id and details to ErrorDescriptionFactory.createErrorDescription</a> |
| </li> |
| <li> |
| (1.13) <a href="#attachSubfixes">Added ErrorDescriptionFactory.attachSubfixes</a> |
| </li> |
| <li> |
| (1.8.1) <a href="#Refreshers">Added PositionRefresher interface and Context</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.spi.editor.hints.Context"><code><span style="color:gray">org.netbeans.spi.editor.hints.</span>Context</code></a> |
| </h2><ul><li>(Jul 20 '09) <a href="#Refreshers">Added PositionRefresher interface and Context</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.hints.ErrorDescriptionFactory"><code><span style="color:gray">org.netbeans.spi.editor.hints.</span>ErrorDescriptionFactory</code></a> |
| </h2><ul><li>(May 17 '12) <a href="#error-description-from-position-bounds">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </li> |
| <li>(Mar 19 '12) <a href="#id-and-details">Added id and details to ErrorDescriptionFactory.createErrorDescription</a> |
| </li> |
| <li>(Feb 24 '10) <a href="#attachSubfixes">Added ErrorDescriptionFactory.attachSubfixes</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.hints.settings.FileHintPreferences"><code><span style="color:gray">org.netbeans.spi.editor.hints.settings.</span>FileHintPreferences</code></a> |
| </h2><ul><li>(Apr 24 '13) <a href="#per-project-hints">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.hints.PositionRefresher"><code><span style="color:gray">org.netbeans.spi.editor.hints.</span>PositionRefresher</code></a> |
| </h2><ul><li>(Jul 20 '09) <a href="#Refreshers">Added PositionRefresher interface and Context</a> |
| </li></ul><hr> |
| <h1> |
| <a name="details-by-api">Details of all changes by API and date</a> |
| </h1> |
| <hr style="width:50%"> |
| <h2> |
| <a name="EditorHintsSPI">Editor Hints</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="fixable-annotation-default-action">Provide a way to have fixable annotation with default action</a> |
| </h3> |
| <em>Jul 24 '17; API spec. version: 1.43.0; made by: mromashova; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=271069"> |
| #271069</a></em> |
| <br> |
| For custom type of annotations will dynamically register this annotation type as fixable, so Fix action (click on the icon) will work for it |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="multiple-annotation-type">Support multiple ranges for ErrorDescriptor</a> |
| </h3> |
| <em>Jul 17 '17; API spec. version: 1.42.0; made by: mromashova; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=271070"> |
| #271070</a></em> |
| <br> |
| 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. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="custom-annotation-type">Added customType field and constructor to ErrorDescription</a> |
| </h3> |
| <em>Aug 26 '15; API spec. version: 1.38.0; made by: danilasergeyev; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=254375"> |
| #254375</a></em> |
| <br> |
| 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. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="per-project-hints">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </h3> |
| <em>Apr 24 '13; API spec. version: 1.31; affected top-level classes: <a href="./org/netbeans/spi/editor/hints/settings/FileHintPreferences.html"><code>FileHintPreferences</code></a>; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=212326"> |
| #212326</a></em> |
| <br> |
| XXX |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="error-description-from-position-bounds">Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</a> |
| </h3> |
| <em>May 17 '12; API spec. version: 1.24; affected top-level classes: <a href="./org/netbeans/spi/editor/hints/ErrorDescriptionFactory.html"><code>ErrorDescriptionFactory</code></a>; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=212326"> |
| #212326</a></em> |
| <br> |
| Added several a new variant of ErrorDescriptionFactory.createErrorDescription |
| taking PositionBounds to specify the span of the error/warning. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="id-and-details">Added id and details to ErrorDescriptionFactory.createErrorDescription</a> |
| </h3> |
| <em>Mar 19 '12; API spec. version: 1.22; affected top-level classes: <a href="./org/netbeans/spi/editor/hints/ErrorDescriptionFactory.html"><code>ErrorDescriptionFactory</code></a>; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=209448"> |
| #209448</a></em> |
| <br> |
| Added several new variants of ErrorDescriptionFactory.createErrorDescription. |
| These new variants allow to specify an optional error/warning id and |
| more details. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="attachSubfixes">Added ErrorDescriptionFactory.attachSubfixes</a> |
| </h3> |
| <em>Feb 24 '10; API spec. version: 1.13; affected top-level classes: <a href="./org/netbeans/spi/editor/hints/ErrorDescriptionFactory.html"><code>ErrorDescriptionFactory</code></a>; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=180724"> |
| #180724</a></em> |
| <br> |
| Added a new method ErrorDescriptionFactory.attachSubfixes that allows |
| to attach sub-fixes to given fix. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="Refreshers">Added PositionRefresher interface and Context</a> |
| </h3> |
| <em>Jul 20 '09; API spec. version: 1.8.1; affected top-level classes: <a href="./org/netbeans/spi/editor/hints/PositionRefresher.html"><code>PositionRefresher</code></a> <a href="./org/netbeans/spi/editor/hints/Context.html"><code>Context</code></a>; made by: msauer</em> |
| <br> |
| Added new interface and context class in order to be able to provide up-to-date hints on current line. |
| |
| |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| |
| </body> |
| |
| </html> |