| <html> |
| <!-- |
| |
| NO NO NO NO NO! |
| |
| ==============> DO NOT EDIT ME! <============== |
| |
| AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT |
| |
| SEE CHANGEME/apichanges.xml |
| |
| --> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Change History for the Editor Guarded Sections API</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="../org-netbeans-modules-editor-guards/architecture-summary.html">-->Editor Guarded Sections API<!--</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="#general">Editor Guarded Sections 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>(Jun 19 '07) <a href="#GuardedSectionsProvider-Charset">GuardedSectionsProvider supports Charset</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-date">All changes by date</a> |
| </h1> |
| <ul> |
| <li>(Feb 17 '16) <a href="#protectRange">Allow to protect existing text</a> |
| </li> |
| <li>(May 21 '14) <a href="#DocumentGuards">DocumentGuards API</a> |
| </li> |
| <li>(Nov 25 '12) <a href="#AbstractGuardedSectionsProvider-useReadersWritersOnSet">Ability run guarded readers/writers when the content of the guarded section's content is set</a> |
| </li> |
| <li>(Jun 19 '07) <a href="#GuardedSectionsProvider-Charset">GuardedSectionsProvider supports Charset</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.guards/1 > 1.20</pre> |
| <ul> |
| <li> |
| (1.33) <a href="#protectRange">Allow to protect existing text</a> |
| </li> |
| <li> |
| (1.29) <a href="#DocumentGuards">DocumentGuards API</a> |
| </li> |
| <li> |
| (1.20) <a href="#AbstractGuardedSectionsProvider-useReadersWritersOnSet">Ability run guarded readers/writers when the content of the guarded section's content is set</a> |
| </li> |
| <li> |
| (1.0) <a href="#GuardedSectionsProvider-Charset">GuardedSectionsProvider supports Charset</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.api.editor.guards.DocumentGuards"><code><span style="color:gray">org.netbeans.api.editor.guards.</span>DocumentGuards</code></a> |
| </h2><ul><li>(May 21 '14) <a href="#DocumentGuards">DocumentGuards API</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.editor.guards.GuardedRegionMarker"><code><span style="color:gray">org.netbeans.spi.editor.guards.</span>GuardedRegionMarker</code></a> |
| </h2><ul><li>(May 21 '14) <a href="#DocumentGuards">DocumentGuards API</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.editor.guards.GuardedSectionManager"><code><span style="color:gray">org.netbeans.api.editor.guards.</span>GuardedSectionManager</code></a> |
| </h2><ul><li>(Feb 17 '16) <a href="#protectRange">Allow to protect existing text</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="general">Editor Guarded Sections API</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="protectRange">Allow to protect existing text</a> |
| </h3> |
| <em>Feb 17 '16; API spec. version: 1.33; affected top-level classes: <a href="./org/netbeans/api/editor/guards/GuardedSectionManager.html"><code>GuardedSectionManager</code></a>; made by: sdedic</em> |
| <br> |
| Added method to create guarded block on top of existing text. |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --><h3> |
| <a name="DocumentGuards">DocumentGuards API</a> |
| </h3> |
| <em>May 21 '14; API spec. version: 1.29; affected top-level classes: <a href="./org/netbeans/spi/editor/guards/GuardedRegionMarker.html"><code>GuardedRegionMarker</code></a> <a href="./org/netbeans/api/editor/guards/DocumentGuards.html"><code>DocumentGuards</code></a>; made by: sdedic; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=244679"> |
| #244679</a></em> |
| <br> |
| |
| <p> |
| APIs exposed and actually used on GuardedDocument in <code>editor.lib</code> module is now declared in Editor Guarded Sections. |
| Clients may depend on Guarded Sections instead of on fading-away editor.lib module. |
| </p> |
| |
| <p> |
| Dependency on <code>openide.text</code> eliminated, new SPI <code>GuardedRegionMarker</code> |
| is added for Documents that are willing to style their contents according to guarded areas. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="AbstractGuardedSectionsProvider-useReadersWritersOnSet">Ability run guarded readers/writers when the content of the guarded section's content is set</a> |
| </h3> |
| <em>Nov 25 '12; API spec. version: 1.20; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=221844"> |
| #221844</a></em> |
| <br> |
| |
| <p>When this option is set, setting the content of a GuardedSection will pass the data through the given |
| guarded writer and back through the given guarded reader, to ensure the result is the same |
| as if it would be read from the disk.</p> |
| |
| <p>Note that this new mode is not fully compatible with the original mode, e.g. all the set methods |
| of all the GuardedSection classes will throw IllegalStateException if invoked inside the write&read part.</p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="GuardedSectionsProvider-Charset">GuardedSectionsProvider supports Charset</a> |
| </h3> |
| <em>Jun 19 '07; API spec. version: 1.0; made by: jpokorsky; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=99363"> |
| #99363</a></em> |
| <br> |
| In order to use proper encoding by guards impl it is necessary to |
| change GuardedSectionsProvider to accept encoding rather as <code>java.nio.Charset</code> instance |
| than as a plain encoding name. |
| <ul> |
| |
| <li> |
| <code>Reader createGuardedReader(InputStream stream, String encoding) throws UnsupportedEncodingException</code> |
| replaced with |
| <code>Reader createGuardedReader(InputStream stream, Charset charset)</code> |
| </li> |
| |
| <li> |
| <code>Writer createGuardedWriter(OutputStream stream, String encoding) throws UnsupportedEncodingException</code> |
| replaced with |
| <code>Reader createGuardedReader(InputStream stream, Charset charset)</code> |
| </li> |
| |
| </ul> |
| |
| |
| |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| |
| </body> |
| |
| </html> |
