| <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 Options Dialog 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="#OptionsAPI">Options Dialog API</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> |
| <li>(Mar 15 '13) <a href="#Import.restart">Should Import Require Restart?</a> |
| </li> |
| <li>(Mar 30 '09) <a href="#classic">"Classic" mode fully implemented in module</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-date">All changes by date</a> |
| </h1> |
| <ul> |
| <li>(Dec 3 '13) <a href="#OptionsPanelController.setSubcategory">API to handle selection of subcategory from a composite OptionspanelController</a> |
| </li> |
| <li>(Mar 15 '13) <a href="#Import.restart">Should Import Require Restart?</a> |
| </li> |
| <li>(Feb 26 '13) <a href="#OptionsDisplayer.openModal">API to control whether the options window should be modal or not when opened</a> |
| </li> |
| <li>(Oct 18 '12) <a href="#OptionsPanelController.handleSuccessfulSearch">API to handle successfull search in some panel in options window</a> |
| </li> |
| <li>(Oct 2 '12) <a href="#optionsSearchAnnotation">Annotation to register keywords for some panel in the Options dialog</a> |
| </li> |
| <li>(Sep 14 '09) <a href="#annotations">Annotations to register dialog panels</a> |
| </li> |
| <li>(Mar 30 '09) <a href="#classic">"Classic" mode fully implemented in module</a> |
| </li> |
| <li>(Jul 17 '08) <a href="#DeclarativeController">Support for searchable options</a> |
| </li> |
| <li>(Jul 11 '08) <a href="#OptionsDisplayerAPI.keywords">Support for searchable options</a> |
| </li> |
| <li>(May 28 '08) <a href="#OptionsDisplayerAPI.subcategory">API to open the options dialog with some subcategory pre-selected</a> |
| </li> |
| <li>(Dec 19 '06) <a href="#OptionsDisplayerAPI">API to open the options dialog with some category pre-selected</a> |
| </li> |
| <li>(Jun 13 '06) <a href="#api_stabilization.options">The Options Dialog API has been stabilized.</a> |
| </li> |
| <li>(Aug 18 '05) <a href="#6.399051298E9">Options Dialog API integrated.</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.modules.options.api/1 > 1.20</pre> |
| <ul> |
| <li> |
| (1.38) <a href="#OptionsPanelController.setSubcategory">API to handle selection of subcategory from a composite OptionspanelController</a> |
| </li> |
| <li> |
| (1.34) <a href="#Import.restart">Should Import Require Restart?</a> |
| </li> |
| <li> |
| (1.33) <a href="#OptionsDisplayer.openModal">API to control whether the options window should be modal or not when opened</a> |
| </li> |
| <li> |
| (1.30) <a href="#OptionsPanelController.handleSuccessfulSearch">API to handle successfull search in some panel in options window</a> |
| </li> |
| <li> |
| (1.29) <a href="#optionsSearchAnnotation">Annotation to register keywords for some panel in the Options dialog</a> |
| </li> |
| <li> |
| (1.14) <a href="#annotations">Annotations to register dialog panels</a> |
| </li> |
| <li> |
| (1.12) <a href="#classic">"Classic" mode fully implemented in module</a> |
| </li> |
| <li> |
| (1.10) <a href="#DeclarativeController">Support for searchable options</a> |
| </li> |
| <li> |
| (1.9) <a href="#OptionsDisplayerAPI.keywords">Support for searchable options</a> |
| </li> |
| <li> |
| (1.8) <a href="#OptionsDisplayerAPI.subcategory">API to open the options dialog with some subcategory pre-selected</a> |
| </li> |
| <li> |
| (1.5) <a href="#OptionsDisplayerAPI">API to open the options dialog with some category pre-selected</a> |
| </li> |
| <li> |
| (1.4) <a href="#api_stabilization.options">The Options Dialog API has been stabilized.</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.spi.options.AdvancedOption"><code><span style="color:gray">org.netbeans.spi.options.</span>AdvancedOption</code></a> |
| </h2><ul><li>(Sep 14 '09) <a href="#annotations">Annotations to register dialog panels</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.options.OptionsDisplayer"><code><span style="color:gray">org.netbeans.api.options.</span>OptionsDisplayer</code></a> |
| </h2><ul><li>(Feb 26 '13) <a href="#OptionsDisplayer.openModal">API to control whether the options window should be modal or not when opened</a> |
| </li> |
| <li>(May 28 '08) <a href="#OptionsDisplayerAPI.subcategory">API to open the options dialog with some subcategory pre-selected</a> |
| </li> |
| <li>(Dec 19 '06) <a href="#OptionsDisplayerAPI">API to open the options dialog with some category pre-selected</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.options.OptionsPanelController"><code><span style="color:gray">org.netbeans.spi.options.</span>OptionsPanelController</code></a> |
| </h2><ul><li>(Dec 3 '13) <a href="#OptionsPanelController.setSubcategory">API to handle selection of subcategory from a composite OptionspanelController</a> |
| </li> |
| <li>(Oct 18 '12) <a href="#OptionsPanelController.handleSuccessfulSearch">API to handle successfull search in some panel in options window</a> |
| </li> |
| <li>(Oct 2 '12) <a href="#optionsSearchAnnotation">Annotation to register keywords for some panel in the Options dialog</a> |
| </li> |
| <li>(Sep 14 '09) <a href="#annotations">Annotations to register dialog panels</a> |
| </li> |
| <li>(Jul 17 '08) <a href="#DeclarativeController">Support for searchable options</a> |
| </li> |
| <li>(Jul 11 '08) <a href="#OptionsDisplayerAPI.keywords">Support for searchable options</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="OptionsAPI">Options Dialog API</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="OptionsPanelController.setSubcategory">API to handle selection of subcategory from a composite OptionspanelController</a> |
| </h3> |
| <em>Dec 3 '13; API spec. version: 1.38; affected top-level classes: <a href="./org/netbeans/spi/options/OptionsPanelController.html"><code>OptionsPanelController</code></a>; made by: theofanis; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=180821"> |
| #180821</a></em> |
| <br> |
| Added API to handle selection of subcategory. It is meant to be called from |
| a composite <code>OptionspanelController</code> and delegates to |
| <code>OptionspanelController.setCurrentSubcategory</code>. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="Import.restart">Should Import Require Restart?</a> |
| </h3> |
| <em>Mar 15 '13; API spec. version: 1.34; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=226998"> |
| #226998</a></em> |
| <br> |
| Should an import of settings require a restart? Some applications |
| need that, some don't. There is a |
| <a href="architecture-summary.html#branding-OPT_RestartAfterImport" shape="rect"> |
| branding API</a> to control such behavior now. |
| <br> |
| <strong>Compatibility: </strong> |
| Compared to previous versions, the default changed - now |
| the restart is not needed. Applications can change that by using |
| <a href="architecture-summary.html#branding-OPT_RestartAfterImport" shape="rect"> |
| this branding API</a> and specifying <code>false</code> as the value |
| of associated key. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="OptionsDisplayer.openModal">API to control whether the options window should be modal or not when opened</a> |
| </h3> |
| <em>Feb 26 '13; API spec. version: 1.33; affected top-level classes: <a href="./org/netbeans/api/options/OptionsDisplayer.html"><code>OptionsDisplayer</code></a>; made by: theofanis; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=207120"> |
| #207120</a></em> |
| <br> |
| Added API to control whether the options window should be modal or not when opened. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="OptionsPanelController.handleSuccessfulSearch">API to handle successfull search in some panel in options window</a> |
| </h3> |
| <em>Oct 18 '12; API spec. version: 1.30; affected top-level classes: <a href="./org/netbeans/spi/options/OptionsPanelController.html"><code>OptionsPanelController</code></a>; made by: theofanis; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=219457"> |
| #219457</a></em> |
| <br> |
| Added API to handle successful search in some panel in options window. |
| By default no action is performed. Each implementor should make special actions, |
| for example to choose a specific sub-panel, if this is required. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="optionsSearchAnnotation">Annotation to register keywords for some panel in the Options dialog</a> |
| </h3> |
| <em>Oct 2 '12; API spec. version: 1.29; affected top-level classes: <a href="./org/netbeans/spi/options/OptionsPanelController.html"><code>OptionsPanelController</code></a>; made by: theofanis; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=218312"> |
| #218312</a></em> |
| <br> |
| Introduced an annotation inside <code>OptionsPanelController</code> |
| to register keywords for some panel in the Options dialog declaratively. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="annotations">Annotations to register dialog panels</a> |
| </h3> |
| <em>Sep 14 '09; API spec. version: 1.14; affected top-level classes: <a href="./org/netbeans/spi/options/OptionsPanelController.html"><code>OptionsPanelController</code></a> <a href="./org/netbeans/spi/options/AdvancedOption.html"><code>AdvancedOption</code></a>; made by: jglick; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=171284"> |
| #171284</a></em> |
| <br> |
| |
| <p> |
| Introduced three annotations inside <code>OptionsPanelController</code> |
| to register Options dialog panels declaratively. |
| </p> |
| |
| <br> |
| <strong>Compatibility: </strong> |
| |
| <p> |
| Deprecated subclassing <code>AdvancedOption</code> and using |
| <code>OptionsPanelController.createAdvanced</code> as these |
| do not do anything you cannot do more easily using annotations. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="classic">"Classic" mode fully implemented in module</a> |
| </h3> |
| <em>Mar 30 '09; API spec. version: 1.12; made by: jglick</em> |
| <br> |
| The <b>Advanced Options</b> button (also known as "classic" mode) is |
| now fully implemented in the Options Dialog and SPI module, rather |
| than in Core. The functionality remains the same: any displayable |
| objects (such as beans) present under the <code>UI/Services</code> |
| configuration folder will trigger the button to be displayed which |
| opens a special dialog for them. |
| <br> |
| <strong>Compatibility: </strong> |
| |
| <p> |
| Platform applications using the old <code>UI/Services</code> now |
| need to include this module. Module developers are however |
| strongly encouraged to use the new Options SPI. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="DeclarativeController">Support for searchable options</a> |
| </h3> |
| <em>Jul 17 '08; API spec. version: 1.10; affected top-level classes: <a href="./org/netbeans/spi/options/OptionsPanelController.html"><code>OptionsPanelController</code></a>; made by: msauer; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=137338"> |
| #137338</a></em> |
| <br> |
| Added new declarative way of registering options categories |
| (advancedOptionFolder attr in layer.xml), in order to remove |
| duplicate tabbed controllers for each category with subtabs |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="OptionsDisplayerAPI.keywords">Support for searchable options</a> |
| </h3> |
| <em>Jul 11 '08; API spec. version: 1.9; affected top-level classes: <a href="./org/netbeans/spi/options/OptionsPanelController.html"><code>OptionsPanelController</code></a>; made by: msauer; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=137338"> |
| #137338</a></em> |
| <br> |
| Added new factory methods enabling declarative loading of option |
| panels (createCategory and createSubCategory) to OptionsCategory |
| and AdvancedOption |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="OptionsDisplayerAPI.subcategory">API to open the options dialog with some subcategory pre-selected</a> |
| </h3> |
| <em>May 28 '08; API spec. version: 1.8; affected top-level classes: <a href="./org/netbeans/api/options/OptionsDisplayer.html"><code>OptionsDisplayer</code></a>; made by: jskrivanek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=109538"> |
| #109538</a></em> |
| <br> |
| Added API to open the options dialog with some subcategory pre-selected. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="OptionsDisplayerAPI">API to open the options dialog with some category pre-selected</a> |
| </h3> |
| <em>Dec 19 '06; API spec. version: 1.5; affected top-level classes: <a href="./org/netbeans/api/options/OptionsDisplayer.html"><code>OptionsDisplayer</code></a>; made by: rmatous; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=74855"> |
| #74855</a></em> |
| <br> |
| Added API to open the options dialog with some category pre-selected. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="api_stabilization.options">The Options Dialog API has been stabilized.</a> |
| </h3> |
| <em>Jun 13 '06; API spec. version: 1.4; made by: rmatous; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=70826"> |
| #70826</a></em> |
| <br> |
| |
| <p> |
| To indicate that this is now considered a stable API, the major release version was |
| incremented to 1 from 0. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="6.399051298E9">Options Dialog API integrated.</a> |
| </h3> |
| <em>Aug 18 '05; made by: jjancura</em> |
| <br> |
| Options Dialog API integrated to NetBeans. |
| |
| |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| |
| </body> |
| |
| </html> |
