blob: ab93aada0cf6dbe80d8234545a3909eac8c3bb37 [file] [log] [blame]
<html>
<!--
NO NO NO NO NO!
==============> DO NOT EDIT ME! <======================
AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT
SEE xml/api/doc/changes/apichanges.xml
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Options Dialog API changes by date</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 Task List APIs. Please ask on the
<code>nbdev@netbeans.org</code>
mailing list if you have any questions about the details of a
change, or are wondering how to convert existing code to be compatible.
</p>
<hr>
<h1>
<a name="list-all-apis">Index of APIs</a>
</h1>
<ul>
<li>
<a href="#TaskListSPI">Task List SPI</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>(Mar 6 '13) <a href="#callback_api">PushTaskScanner.Callback provides additional information.</a>
</li>
<li>(Aug 7 '09) <a href="#issue_support">Task List implementation uses Indexing API to cache scanned tasks.</a>
</li>
<li>(Mar 31 '09) <a href="#indexing_api">Task List implementation uses Indexing API to cache scanned tasks.</a>
</li>
<li>(Apr 11 '07) <a href="#api_review">API changes to reflect the results of API inception review.</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.tasklist/1 &gt; 1.20</pre>
<ul>
<li>
(1.24) <a href="#callback_api">PushTaskScanner.Callback provides additional information.</a>
</li>
<li>
(1.6) <a href="#issue_support">Task List implementation uses Indexing API to cache scanned tasks.</a>
</li>
<li>
(1.4) <a href="#indexing_api">Task List implementation uses Indexing API to cache scanned tasks.</a>
</li>
<li>
(1.0) <a href="#api_review">API changes to reflect the results of API inception review.</a>
</li>
</ul>
<h1>
<a name="all-by-class">Changes by affected class</a>
</h1>
<hr>
<h1>
<a name="details-by-api">Details of all changes by API and date</a>
</h1>
<hr style="width:50%">
<h2>
<a name="TaskListSPI">Task List SPI</a>
</h2>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="callback_api">PushTaskScanner.Callback provides additional information.</a>
</h3>
<em>Mar 6 '13; API spec. version: 1.24; made by: jpeska; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=227107">
#227107</a></em>
<br>
<p>
PushTaskScanner.Callback provides information whether the framework is observed and whether the current editor scope is set.
Both these methods are needed for performance improvements of NB PushTaskScanners.
</p>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="issue_support">Task List implementation uses Indexing API to cache scanned tasks.</a>
</h3>
<em>Aug 7 '09; API spec. version: 1.6; made by: saubrecht; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=169975">
#169975</a></em>
<br>
<p>
Task List API and user interface has been extended to support a generic URL
as the resource the task is associated with. This allows for example
bug tracking issues to be displayed in Task List window.
</p>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="indexing_api">Task List implementation uses Indexing API to cache scanned tasks.</a>
</h3>
<em>Mar 31 '09; API spec. version: 1.4; made by: saubrecht</em>
<br>
<p>
Task List implementation uses Indexing API to persist tasks created
by FileTaskScanners. If a file hasn't changed since the last scan
then the tasks associated with that file are loaded from cache to improve
Task List performance. Therefore task's ActionListener isn't available when
the task is restored from cache. Task providers must switch to PushTaskScanner
if ActionListener is required to be available at all times.
</p>
<!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! -->
<h3>
<a name="api_review">API changes to reflect the results of API inception review.</a>
</h3>
<em>Apr 11 '07; API spec. version: 1.0; made by: saubrecht</em>
<br>
<p>
API has changed due to the results of API inception review.
</p>
<hr>
<p><span class="footnote">Built on September 14 2018.&nbsp;&nbsp;|&nbsp;&nbsp; Copyright &#169; 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p>
</body>
</html>