Source

main-silver / editor.lib / apichanges.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.


The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://www.netbeans.org/cddl-gplv2.html
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License file at
nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
particular file as subject to the "Classpath" exception as provided
by Sun in the GPL Version 2 section of the License file that
accompanied this code. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

Contributor(s):

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 2, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 2] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 2 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 2 code and therefore, elected the GPL
Version 2 license, then the option applies only if the new code is
made subject to such option by the copyright holder.
-->
<?xml-stylesheet type="text/xml" href="../../nbbuild/javadoctools/apichanges.xsl"?>
<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../../nbbuild/javadoctools/apichanges.dtd">

<!--

INFO FOR PEOPLE ADDING CHANGES:

Check the DTD (apichanges.dtd) for details on the syntax. You do not
need to regenerate the HTML, as this is part of Javadoc generation; just
change the XML. Rough syntax of a change (several parts optional):

<change>
    <api name="compiler"/>
    <summary>Some brief description here, can use <b>XHTML</b></summary>
    <version major="1" minor="99"/>
    <date day="13" month="6" year="2001"/>
    <author login="jrhacker"/>
    <compatibility addition="yes"/>
    <description>
        The main description of the change here.
        Again can use full <b>XHTML</b> as needed.
    </description>
    <class package="org.openide.compiler" name="DoWhatIWantCompiler"/>
    <issue number="14309"/>
</change>

Also permitted elements: <package>, <branch>. <version> is API spec
version, recommended for all new changes. <compatibility> should say
if things were added/modified/deprecated/etc. and give all information
related to upgrading old code. List affected top-level classes and
link to issue numbers if applicable. See the DTD for more details.

Changes need not be in any particular order, they are sorted in various
ways by the stylesheet anyway.

Dates are assumed to mean "on the trunk". If you *also* make the same
change on a stabilization branch, use the <branch> tag to indicate this
and explain why the change was made on a branch in the <description>.

Please only change this file on the trunk! Rather: you can change it
on branches if you want, but these changes will be ignored; only the
trunk version of this file is important.

Deprecations do not count as incompatible, assuming that code using the
deprecated calls continues to see their documented behavior. But do
specify deprecation="yes" in <compatibility>.

This file is not a replacement for Javadoc: it is intended to list changes,
not describe the complete current behavior, for which ordinary documentation
is the proper place.

-->

<apichanges>

    <!-- First, a list of API names you may use: -->
    <apidefs>
        <apidef name="general">General</apidef>
        <!-- etc. -->
    </apidefs>

    <!-- ACTUAL CHANGES BEGIN HERE: -->

    <changes>

        <change id="LineSeparatorConversion.deprecated">
            <summary>Deprecating LineSeparatorConversion</summary>
            <version major="1" minor="20"/>
            <date day="17" month="10" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" addition="no" deprecation="yes"/>
            <description>
                <p>
                    Deprecating LineSeparatorConversion in favor of
                    <code>org.netbeans.lib.editor.util.CharacterConversions</code>.
                </p>
            </description>
        </change>
        
        <change id="BaseDocument.getLegacyFormatter">
            <summary>Added BaseDocument.getLegacyFormatter()</summary>
            <version major="1" minor="19"/>
            <date day="13" month="10" year="2007"/>
            <author login="mmetelka"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" addition="yes"/>
            <description>
                <p>
                    The <code>BaseDocument.getLegacyFormatter()</code> was added
                    to allow the new indent infrastructure to delegate to legacy
                    formatter in case the new indent API was called explicitly.
                </p>
            </description>
        </change>
        
        <change id="HyperlinkProviderExt">
            <summary>Extending HyperlinkProviders</summary>
            <version major="1" minor="18"/>
            <date day="20" month="9" year="2007"/>
            <author login="jlahoda"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" addition="yes"/>
            <description>
                <p>
                    The hyperlink providers have been extended to allow:
                </p>
                
                <ul>
                    <li>tooltips for the hyperlinks</li>
                    <li>future extensions through <code>HyperlinkType</code></li>
                </ul>
                    
                <p>
                    See newly added <code>HyperlinkProviderExt</code> class.
                </p>
            </description>
            <issue number="115359" />
        </change>
        
        <change id="BaseDocumentEvent.getChangeAttributes.added">
            <summary>Added BaseDocumentEvent.getChangeAttributes</summary>
            <version major="1" minor="17"/>
            <date day="22" month="8" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" addition="yes"/>
            <description>
                <p>
                    The <code>BaseDocumentEvent.getChangeAttributes()</code> was added
                    in order to be able to find out the attributes supplied
                    when calling <code>Document.insertString()</code>.
                </p>
            </description>
        </change>

        <change id="ExtKit.ToggleCommentAction.added">
            <summary>Added ExtKit.ToggleCommentAction</summary>
            <version major="1" minor="16"/>
            <date day="23" month="7" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" deprecation="no" addition="yes"/>
            <description>
                <p>
                    The <code>ExtKit.ToggleCommentAction</code> was added as a
                    replacement for the <code>ExtKit.CommentAction</code> and
                    <code>ExtKit.UncommentAction</code> actions.
                </p>
            </description>
        </change>

        <change id="BracesMatching.spi.related.deprecations">
            <summary>Several things were deprecated in favor of BracesMatching SPI</summary>
            <version major="1" minor="15"/>
            <date day="7" month="6" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" deprecation="yes" />
            <description>
                <p>
                    Some fields and methods in <code>ExtCaret</code> and <code>ExtKit</code>
                    that were related to highlighting matching braces in a document
                    are no longer supported. There is new Braces Matching SPI available,
                    which replaces them.
                </p>
                <p>
                    The <code>ExtCaret.setMatchBraceOffset</code> and the <code>MATCH_BRACE_*</code>
                    added in 1.14 were removed again. This is in fact no change,
                    because these methods have never been part of any release.
                </p>
            </description>
        </change>

        <change id="ExtCaret-matchBraceOffset">
            <summary>Adding ExtCaret.get/setMatchBraceOffset</summary>
            <version major="1" minor="14"/>
            <date day="2" month="5" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" />
            <description>
                <p>
                    The <code>ExtCaret.setMatchBraceOffset</code> and the <code>MATCH_BRACE_*</code>
                    constants can be used for customizing the algorithm for
                    finding a matching bracket. The options are: match a breacket
                    before caret, after caret or either side.
                </p>
            </description>
        </change>

        <change id="JumpList-final">
            <summary>Making JumpList final</summary>
            <version major="1" minor="13"/>
            <date day="2" month="4" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="incompatible" semantic="compatible" />
            <description>
                <p>
                    The JumpList was never meant to be subclassed or instantialized
                    even though the class did not prevent it. It is now final with
                    private constructor; the same for JumpList.Entry class.
                </p>
            </description>
        </change>
        
        <change id="draw-layers-disabled">
            <summary>Deprecating the use of <code>DrawLayer</code></summary>
            <version major="1" minor="12"/>
            <date day="8" month="1" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" />
            <description>
                <p>
                    Using <code>DrawLayer</code> and related classes and methods
                    has been deprecated in favor of the new Highlighting SPI in
                    the editor/lib2 module. For more details see
                    <a href="@org-netbeans-modules-editor-lib2@/overview-summary.html">Highlighting SPI</a>.
                </p>
            </description>
        </change>
        
        <change id="Coloring.fromAttributeSet">
            <summary>Adding Coloring.fromAttributeSet method</summary>
            <version major="1" minor="11"/>
            <date day="5" month="1" year="2007"/>
            <author login="vstejskal"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible" addition="yes"/>
            <description>
                <p>
                    Adding <code>Coloring.fromAttributeSet</code> static
                    method to provide a simple and correct way of converting colorings
                    from the format used by the new settings infrastructure to
                    the format used by <code>DrawEngine</code> and various
                    <code>DrawLayer</code>s.
                </p>
            </description>
        </change>

        <change id="created">
            <summary>editor/lib now has its own arch and apichanges documents.</summary>
            <version major="1" minor="9"/>
            <date day="28" month="11" year="2005"/>
            <author login="mmetelka"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible"/>
            <description>
                <p>
                    Separate arch and apichanges documents extracted from editor to editor/lib.
                </p>
            </description>
        </change>

    </changes>

    <!-- Now the surrounding HTML text and document structure: -->

    <htmlcontents>
<!-- Generated from apichanges.xml -->
    <head>
      <title>Change History for the Editor Library API</title>
      <link rel="stylesheet" href="prose.css" type="text/css"/>
    </head>
    <body>

<p class="overviewlink"><a href="overview-summary.html">Overview</a></p>

<h1>Introduction</h1>

<p>This document lists changes made to the <a href="overview-summary.html">Editor Library API</a>.</p>

<!-- The actual lists of changes, as summaries and details: -->
      <hr/>
      <standard-changelists module-code-name="org.netbeans.modules.editor.lib/1"/>

      <hr/><p>@FOOTER@</p>

    </body>
  </htmlcontents>

</apichanges>