| <html> |
| <!-- |
| |
| NO NO NO NO NO! |
| |
| ==============> DO NOT EDIT ME! <====================== |
| |
| AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT |
| |
| SEE editor/fold/apichanges.xml |
| |
| --> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Fold API Changes by Date</title> |
| |
| <link rel="stylesheet" href="prose.css" type="text/css"> |
| |
| <meta name="CATEGORY" content="OtherDevelopmentDoc"> |
| |
| <meta name="DESCRIPTION" content="A cross-indexed list of all changes made to the Fold API."> |
| |
| </head> |
| |
| <body> |
| |
| |
| <h1>Introduction</h1> |
| |
| |
| <h2>What do the Dates Mean?</h2> |
| |
| |
| <p>The supplied dates indicate when the API change was made, on the CVS |
| trunk. From this you can generally tell whether the change should be |
| present in a given build or not; for trunk builds, simply whether it |
| was made before or after the change; for builds on a stabilization |
| branch, whether the branch was made before or after the given date. In |
| some cases corresponding API changes have been made both in the trunk |
| and in an in-progress stabilization branch, if they were needed for a |
| bug fix; this ought to be marked in this list.</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="#api">Fold 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></ul> |
| <h1> |
| <a name="all-by-date">All changes by date</a> |
| </h1> |
| <ul> |
| <li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li> |
| <li>(Mar 8 '13) <a href="#fold-editorlib-separation">Fold UI separation from Editor Library</a> |
| </li> |
| <li>(Mar 3 '08) <a href="#FoldOperation-owns-added">FoldOperation.owns(Fold) added</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.editor.fold/1 > 1.20</pre> |
| <ul> |
| <li> |
| (1.35) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li> |
| <li> |
| (1.34) <a href="#fold-editorlib-separation">Fold UI separation from Editor Library</a> |
| </li> |
| <li> |
| (1.8) <a href="#FoldOperation-owns-added">FoldOperation.owns(Fold) added</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.api.editor.fold.Fold"><code><span style="color:gray">org.netbeans.api.editor.fold.</span>Fold</code></a> |
| </h2><ul><li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.editor.fold.FoldHierarchy"><code><span style="color:gray">org.netbeans.api.editor.fold.</span>FoldHierarchy</code></a> |
| </h2><ul><li>(Mar 8 '13) <a href="#fold-editorlib-separation">Fold UI separation from Editor Library</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.fold.FoldHierarchyMonitor"><code><span style="color:gray">org.netbeans.spi.editor.fold.</span>FoldHierarchyMonitor</code></a> |
| </h2><ul><li>(Mar 8 '13) <a href="#fold-editorlib-separation">Fold UI separation from Editor Library</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.fold.FoldInfo"><code><span style="color:gray">org.netbeans.spi.editor.fold.</span>FoldInfo</code></a> |
| </h2><ul><li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.editor.fold.FoldingSupport"><code><span style="color:gray">org.netbeans.api.editor.fold.</span>FoldingSupport</code></a> |
| </h2><ul><li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li> |
| <li>(Mar 8 '13) <a href="#fold-editorlib-separation">Fold UI separation from Editor Library</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.editor.fold.FoldType"><code><span style="color:gray">org.netbeans.api.editor.fold.</span>FoldType</code></a> |
| </h2><ul><li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.fold.FoldTypeProvider"><code><span style="color:gray">org.netbeans.spi.editor.fold.</span>FoldTypeProvider</code></a> |
| </h2><ul><li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.editor.fold.FoldUtilities"><code><span style="color:gray">org.netbeans.api.editor.fold.</span>FoldUtilities</code></a> |
| </h2><ul><li>(Mar 12 '13) <a href="#fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</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="api">Fold API</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="fold-api-enhancements">Extensible FoldTypes, enhanced support for fold updates</a> |
| </h3> |
| <em>Mar 12 '13; API spec. version: 1.35; affected top-level classes: <a href="./org/netbeans/spi/editor/fold/FoldTypeProvider.html"><code>FoldTypeProvider</code></a> <a href="./org/netbeans/spi/editor/fold/FoldInfo.html"><code>FoldInfo</code></a> <a href="./org/netbeans/api/editor/fold/FoldType.html"><code>FoldType</code></a> <a href="./org/netbeans/api/editor/fold/Fold.html"><code>Fold</code></a> <a href="./org/netbeans/api/editor/fold/FoldUtilities.html"><code>FoldUtilities</code></a> <a href="./org/netbeans/api/editor/fold/FoldingSupport.html"><code>FoldingSupport</code></a>; made by: sdedic; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=226413"> |
| #226413</a></em> |
| <br> |
| |
| <p> |
| |
| <code>FoldTypes</code> can be defined for a <i>mime type</i> by <code>FoldTypeProviders</code>. They |
| can form a type hierarchy. <code>FoldUtilities</code> provide methods to check fold enablement and |
| available FoldTypes. Working directly with Preferences is not advised. |
| </p> |
| |
| <p> |
| Fold can provide offsets to start and end of its content excluding <i>guard areas</i>. <code>FoldingSupport</code> |
| provides factories for comment-driven <code>FoldManager</code> and for fold <code>ContentReader</code> capable |
| of reading javadoc-style comments or similar. |
| </p> |
| |
| <p> |
| |
| <code>FoldOperation</code> allows to <code>update</code> folds with <code>FoldInfos</code>, removing, adding |
| or updating Folds as necessary. Existing FoldManagers can be simplified. Folds can be defined wihtout |
| initial state - the state will be determined form the options by the infrastructure. All folds defined |
| by a FoldManager can be retrieved from <code>FoldOperation.foldIterator()</code>, even though they are |
| blocked. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="fold-editorlib-separation">Fold UI separation from Editor Library</a> |
| </h3> |
| <em>Mar 8 '13; API spec. version: 1.34; affected top-level classes: <a href="./org/netbeans/api/editor/fold/FoldHierarchy.html"><code>FoldHierarchy</code></a> <a href="./org/netbeans/api/editor/fold/FoldingSupport.html"><code>FoldingSupport</code></a> <a href="./org/netbeans/spi/editor/fold/FoldHierarchyMonitor.html"><code>FoldHierarchyMonitor</code></a>; made by: sdedic; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=226368"> |
| #226368</a> <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=226413"> |
| #226413</a></em> |
| <br> |
| |
| <p> |
| |
| <code>FoldHierarchyMonitor</code> was introduced to allow hooking into UI when |
| a FoldHierarchy is produced for a JTextComponent. The 'active' flag is provided on |
| the <code>FoldHierarchy</code> to determine whether the hierarchy be popuplated with folds |
| at all. |
| </p> |
| |
| <p> |
| Using <code>FoldingSupport</code> utility class, clients can create instance of |
| <code>FoldManager</code> that creates folds based on comments, previously <code>CustomFoldManager</code> |
| in editor.lib module. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="FoldOperation-owns-added">FoldOperation.owns(Fold) added</a> |
| </h3> |
| <em>Mar 3 '08; API spec. version: 1.8; made by: mmetelka; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=108030"> |
| #108030</a></em> |
| <br> |
| |
| <p> |
| Added FoldOperation.owns(Fold) to check whether fold was produced |
| by a particular FoldOperation. |
| </p> |
| |
| |
| |
| </body> |
| |
| </html> |
