Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
<question id="arch-what"> What is this project good for? <hint> Please provide here few lines describing the the project, what problem it should solve, provide links to documentation, specifications, etc. </hint> </question>
-->
<answer id="arch-what">
<p>
The Editor Library 2 module is a set of official APIs and SPIs, designed to
replaces the original Editor Library with legacy APIs
that are not properly structured and do not conform to the rules
implied on the current NB APIs.
</p>
<p>
The APIs currently offered in Editor Library 2 module include:
</p>
<!-- <question id="arch-overall" when="init"> Describe the overall architecture. <hint> What will be API for <a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi"> clients and what support API</a>? What parts will be pluggable? How will plug-ins be registered? Please use <code><api type="export"/></code> to describe your general APIs. If possible please provide simple diagrams. </hint> </question>
-->
<answer id="arch-overall">
The Netbeans editor infrastructure provides an implementation of the Swing Text
package APIs as well as some additional features such as syntax coloring, code
folding, braces matching, etc.
<br/>
</answer>
<!-- <question id="arch-usecases" when="init"> Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase"> use cases</a> of the new API. Who will use it at what circumstances and what will be the typical code to write to use the module. </question>
-->
<answer id="arch-usecases">
At the moment the Editor Library 2 module contains distinct APIs/SPIs. They live
in their own package and the usecases can be found in the packages overview.
<ul>
<li>Code Generator SPI -
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/spi/editor/codegen/package-summary.html#usecases">org.netbeans.spi.editor.codegen</a>
</li>
<li>Highlighting SPI -
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/spi/editor/highlighting/package-summary.html#usecases">org.netbeans.spi.editor.highlighting</a>
</li>
<li>Typing Hooks SPI -
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/spi/editor/typinghooks/package-summary.html#usecases">org.netbeans.spi.editor.typinghooks</a>
</li>
<li>Caret API -
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/api/editor/caret/package-summary.html#usecases">org.netbeans.api.editor.caret</a>
</li>
<li>Caret SPI -
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/spi/editor/caret/package-summary.html#usecases">org.netbeans.spi.editor.caret</a>
</li>
</ul>
</answer>
<!-- <question id="arch-quality" when="init"> How the quality of your code will be tested and how future regressions are going to be prevented? <hint> What kind of testing you want to use? What/how much area of functionality should be covered by the tests? </hint> </question>
-->
<answer id="arch-quality">
Code is accompanied with unit tests.
</answer>
<!-- <question id="arch-time" when="init"> What are the time estimates of the work? <hint> Please express your estimates of how long the design, implementation, stabilization are likely to last. How many people will be needed to implement this and what is the expected milestone the work should be ready. </hint> </question>
-->
<answer id="arch-time">
The migration process from the old APIs in Editor Library to the new ones
in Editor Library 2 is a long task without any clear time frame. We will
gradually keep deprecating parts of Editor Library and Editor module and
announce their replacements in the Editor Library 2 or other specialized
modules.
</answer>
<!-- <question id="arch-where" when="init"> Where one can find sources for your module? <hint> Please provide link to the CVS web client at http://www.netbeans.org/download/source_browse.html or just use tag defaultanswer generate='here' </hint> </question>
-->
<answer id="arch-where">
<defaultanswer generate='here' />
</answer>
<!-- Question: compat-i18n
<question id="compat-i18n"> Is your module correctly internationalized? <hint> Correct internationalization means that it obeys instuctions at <a href="http://www.netbeans.org/devhome/docs/i18n/index.html"> NetBeans I18N pages</a>. </hint> </question>
-->
<answer id="compat-i18n">
Yes.
</answer>
<!-- Question: compat-standards
<question id="compat-standards"> Does the module implements or defines any standards? Is the implementation exact or it deviates somehow? </question>
-->
<answer id="compat-standards">
It conforms to the Swing Text Package API.
</answer>
<!-- Question: compat-version
<question id="compat-version"> Does your module properly coexists with earlier and future versions? Can you correctly read settings? Will future versions be able to read settings? <hint> Very helpful for reading settings is to store version number there, so future versions can decide whether how to read/convert the settings and older versions can ignore the new ones. </hint> </question>
-->
<answer id="compat-version">
Yes.
</answer>
<!-- Question: dep-jre
<question id="dep-jre"> Which version of JRE you need (1.2, 1.3, 1.4, etc.)? <hint> It is expected that if your module runs on 1.x that it will run on 1.x+1 if no, state that please. Also describe here cases where you run different code on different versions of JRE and why. </hint> </question>
-->
<answer id="dep-jre">
Needs at least JRE 1.5.
</answer>
<!-- Question: dep-jrejdk
<question id="dep-jrejdk"> Do you require JDK or is JRE enough? </question>
-->
<answer id="dep-jrejdk">
JRE is sufficient.
</answer>
<!-- Question: dep-nb
<question id="dep-nb"> What other NetBeans projects this one depends on? <hint> If you want, describe such projects as imported API using the <code><api name="identification" type="import or export" category="stable" url="where is the description" /></code> </hint> </question>
-->
<answer id="dep-nb">
<defaultanswer generate='here'/>
</answer>
<!-- Question: dep-non-nb
<question id="dep-non-nb"> What other non-NetBeans projects this one depends on? <hint> Some non-NetBeans projects are packaged as NetBeans modules (see <a href="http://libs.netbeans.org">libraries</a>) and it is prefered to use this approach when more modules may depend on such third-party library. </hint> </question>
-->
<answer id="dep-non-nb">
None.
</answer>
<!-- Question: dep-platform
<question id="dep-platform"> On which platforms your module run? Any? Does it run in the same way? <hint> If your module is using JNI or deals with special differences of OSes like filesystems, etc. please describe here what they are. </hint> </question>
-->
<answer id="dep-platform">
The module is 100% pure Java and runs on any platform.
</answer>
<!-- <question id="deploy-dependencies" when="final"> What do other modules need to do to declare a dependency on this one? <hint> Provide a sample of the actual lines you would add to a module manifest to declare a dependency, for example using OpenIDE-Module-Module-Dependencies or OpenIDE-Module-Requires. You may use the magic token @SPECIFICATION-VERSION@ to represent the current specification version of the module. </hint> </question>
-->
<answer id="deploy-dependencies">
Just normal module dependency.
</answer>
<!-- Question: deploy-jar
<question id="deploy-jar"> Do you deploy just module JAR file(s) or some other files? <hint> If your module consist just from one module JAR file, just confirm that. If it uses more than one JAR, describe where there are located, how they refer to each other. If it consist of module JAR(s) and other files, please describe what is their purpose, why other files are necessary. Please make sure that installation/deinstallation leaves the system in state as it was before installation. </hint> </question>
-->
<answer id="deploy-jar">
No additional files.
</answer>
<!-- Question: deploy-nbm
<question id="deploy-nbm"> Can you deploy NBM via AutoUpdate center? <hint> If not why? </hint> </question>
-->
<answer id="deploy-nbm">
Yes.
</answer>
<!-- Question: deploy-packages
<question id="deploy-packages"> Are packages of your module made inaccessible by not declaring them public? <hint> NetBeans module system allows restriction of access rights to public classes of your module from other modules. This prevents unwanted dependencies of others on your code and should be used whenever possible (<a href="http://www.netbeans.org/download/apis/org/openide/doc-files/upgrade.html#3.4-public-packages"> public packages </a>). </hint> </question>
-->
<answer id="deploy-packages">
Yes, where appropriate.
</answer>
<!-- Question: deploy-shared
<question id="deploy-shared"> Do you need to be installed in shared location or only in user directory? <hint> Installation location shall not matter, if it does explain why. </hint> </question>
-->
<answer id="deploy-shared">
Module can be installed anywhere.
</answer>
<!-- Question: exec-classloader
<question id="exec-classloader"> Does your code uses own classloader? <hint> A bit unusual. Please explain why and what for. </hint> </question>
-->
<answer id="exec-classloader">
No.
</answer>
<!-- Question: exec-component
<question id="exec-component"> Is execution of your code influenced by (string) property of any of your components? <hint> Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code> or <code>PropertyDescriptor.getValue</code>, etc. are used to influence a behaviour of some code. This of course forms an interface that should be documented. Also if one depends on some interface that an object implements (<code>component instanceof Runnable</code>) that forms an API as well. </hint> </question>
-->
<answer id="exec-component">
<p>
Yes, the Highlighting SPI recognizes the following client properties that can
be set on a <code>JTextComponenet</code>.
</p>
<ul>
<li>
<api name="HighlightsLayerIncludes" group="property" category="official"type="export" >
Defines a regular expression that can be used for filtering out highlighting
layers used for rendering a text component. If specified, any layer with id matching the regular expression <b>will</b> be used for rendering the
component. By default, when the property is not specified or is <code>null</code>,
all layers are used. See
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/spi/editor/highlighting/package-summary.html#usecase5">Use case 5.</a>
for more details.
</api></li>
<li>
<api name="HighlightsLayerExcludes" group="property" category="official"type="export" >
Defines a regular expression that can be used for filtering out highlighting
layers used for rendering a text component. If specified, any layer with id matching the regular expression <b>will not</b> be used for rendering the
component. By default, when the property is not specified or is <code>null</code>,
all layers are used. See
<a href="@org-netbeans-modules-editor-lib2@/org/netbeans/spi/editor/highlighting/package-summary.html#usecase5">Use case 5.</a>
for more details.
</api></li>
</ul>
</answer>
<!-- Question: exec-privateaccess
<question id="exec-privateaccess"> Are you aware of any other part of the system calling some of your methods by reflection? <hint> If so, describe the "contract" as an API. Likely private or friend one, but still API and consider rewrite of it. </hint> </question>
-->
<answer id="exec-privateaccess">
No.
</answer>
<!-- Question: exec-property
<question id="exec-property"> Is execution of your code influenced by any environment of system (<code>System.getProperty</code>) property? <hint> If there is a property that can change the behaviour of your code, somebody will likely use it. You should describe what it does and the stability category of this API. You may use <PRE> <property name="id" category="private" > description of the property, where it is used, what it influence, etc. </property> </PRE> </hint> </question>
-->
<answer id="exec-property">
No.
</answer>
<!-- Question: exec-reflection
<question id="exec-reflection"> Does your code uses java.lang.reflect to execute some other code? <hint> This usually indicates a missing or unsufficient API in the other part of the system. If the other side is not aware of your dependency this contract can be easily broken. </hint> </question>
-->
<answer id="exec-reflection">
No.
</answer>
<!-- Question: format-clipboard
<question id="format-clipboard"> Which protocols your code reads/inserts when communicating with clipboard? </question>
-->
<answer id="format-clipboard">
None.
</answer>
<!-- Question: format-dnd
<question id="format-dnd"> Which protocols your code understands during drag-n-drop? </question>
-->
<answer id="format-dnd">
None.
</answer>
<!-- Question: format-types
<question id="format-types"> Which file formats your code reads or writes on disk? </question>
-->
<answer id="format-types">
None. Reading/writing files into editor document is not handled in this module.
</answer>
<!-- Question: lookup-lookup
<question id="lookup-lookup"> Does your module uses <code>org.openide.util.Lookup</code> to find any components to communicate to? Which ones? <hint> Please describe the interfaces you are searching for, where are defined, whether you are searching for just one or more of them, if the order is important, etc. Also clasify the stability of such API contract. </hint> </question>
-->
<answer id="lookup-lookup">
The module uses <code>MimeLookup</code> for various purposes. The Highlighting
SPI looks up factories for highlighing layers registered in MimeLookup under
a mime type of documents that those layer wish to colorify.
</answer>
<!-- Question: lookup-register
<question id="lookup-register"> Do you register anything into the lookup for other to find? <hint> Do you register using layer file or using <code>META-INF/services</code>? Who is supposed to find your component? </hint> </question>
-->
<answer id="lookup-register">
Yes. There are some implementations of highlighting layers provided by this
module and they are registered in <code>MimeLookup</code>.
</answer>
<!-- Question: lookup-remove
<question id="lookup-remove"> Are removing entries of other modules from the lookup? <hint> Why? Of course, that is possible, but it can be dangerous. Is the module your are masking resource from aware of what you are doing? </hint> </question>
-->
<answer id="lookup-remove">
No.
</answer>
<!-- Question: perf-exit
<question id="perf-exit"> Does your module executes anything on exit? </question>
-->
<answer id="perf-exit">
No.
</answer>
<!-- Question: perf-huge_dialogs
<question id="perf-huge_dialogs"> Does your module contain any dialogs or wizards with huge amount of GUI controls like combo boxes, lists, trees, text areas? </question>
-->
<answer id="perf-huge_dialogs">
No.
</answer>
<!-- Question: perf-limit
<question id="perf-limit"> Are there any limits in number/size of elements your code can handle? </question>
-->
<answer id="perf-limit">
No explicit limits. Technically, the available memory size is the limit...
</answer>
<!-- Question: perf-mem
<question id="perf-mem"> What is the amount of memory your component occupies? Estimate with a relaction to the number of windows, etc. </question>
-->
<answer id="perf-mem">
One average source file opened in the editor occupies roughly 500KB.
</answer>
<!-- Question: perf-menus
<question id="perf-menus"> Does your module use dynamically changing context menus or context sensitive actions with complicated logic for enable/disable? </question>
-->
<answer id="perf-menus">
No.
</answer>
<!-- Question: perf-progress
<question id="perf-progress"> Does your module executes some long running task? <hint>Typically they are tasks like connecting over network, computing huge amount of data, compilation. Such communication should be done asynchronously (for example using <code>RequestProcessor</code>), definitively it should not block AWT thread. </hint> </question>
-->
<answer id="perf-progress">
Opening a file in the editor can be a long task for large files.
</answer>
<!-- Question: perf-scale
<question id="perf-scale"> Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales? Please include some estimates. </question>
-->
<answer id="perf-scale">
<p>
The number of characters in a file multiplied by 2 to respect
2 bytes for each unicode character.
</p>
<p>
Each line is represented by a line element, which takes up about 96 bytes and
a position object occupying another 48 bytes.
</p>
</answer>
<!-- Question: perf-startup
<question id="perf-startup"> Does your module executes anything on startup? </question>
-->
<answer id="perf-startup">
No.
</answer>
<!-- Question: perf-wakeup
<question id="perf-wakeup"> Is any piece of your code waking up periodically? </question>
-->
<answer id="perf-wakeup">
No.
</answer>
<!-- Question: resources-file
<question id="resources-file"> Does your module use <code>java.io.File</code> directly? <hint> NetBeans provide a logical wrapper over plain files called <code>org.openide.filesystems.FileObject</code> that provides uniform access to such resources and is the prefered way that should be used. But of course there can be situations when this is not suitable. </hint> </question>
-->
<answer id="resources-file">
No.
</answer>
<!-- Question: resources-layer
<question id="resources-layer"> Does your module provide own layer? Does it create some files or folders on it? What it is trying to communicate by that and with which component? <hint> NetBeans allows automatic and declarative installation of resources by module layers. Module register files into appropriate places and other components use that information to perform their task (build menu, toolbar, window layout, list of templates, set of options, etc.). </hint> </question>
-->
<answer id="resources-layer">
Yes. The module registers a factory for highlighting layers implemented in
the module.
</answer>
<!-- Question: resources-mask
<question id="resources-mask"> Does your module mask/hide/override any resource provided by another one in module layer? <hint> If you mask a file provided by another module, you probably depend on that and do not want the other module to (for example) change the file's name. That module shall thus make that file available as an API of some stability category. </hint> </question>
-->
<answer id="resources-mask">
No.
</answer>
<!-- Question: resources-read
<question id="resources-read"> Does your module read any resources from layers? For what purpose? <hint> As this is some kind of intermodule dependency, it is a kind of API. Please describe it and clasify according to <a href="http://openide.netbeans.org/tutorial/api-design.html#categories"> common stability categories</a>. </hint> </question>
-->
<answer id="resources-read">
No.
</answer>
<!-- <question id="exec-introspection"> Does your module use any kind of runtime type informations (instanceof, work with java.lang.Class, etc.)? <hint> Check for cases when you have an object of type A and you also expect it to (possibly) be of type B and do some special action. That should be documented. The same applies on operations in meta-level (Class.isInstance(...), Class.isAssignableFrom(...), etc.). </hint> </question>
-->
<answer id="exec-introspection">
No.
</answer>
<!-- <question id="exec-process"> Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code? <hint> If you feed an input, parse the output please declare that as an API. </hint> </question>
-->
<answer id="exec-process">
No.
</answer>
<!-- <question id="exec-threading" when="impl"> What threading models, if any, does your module adhere to? <hint> If your module calls foreign APIs which have a specific threading model, indicate how you comply with the requirements for multithreaded access (synchronization, mutexes, etc.) applicable to those APIs. If your module defines any APIs, or has complex internal structures that might be used from multiple threads, declare how you protect data against concurrent access, race conditions, deadlocks, etc., and whether such rules are enforced by runtime warnings, errors, assertions, etc. Examples: a class might be non-thread-safe (like Java Collections); might be fully thread-safe (internal locking); might require access through a mutex (and may or may not automatically acquire that mutex on behalf of a client method); might be able to run only in the event queue; etc. Also describe when any events are fired: synchronously, asynchronously, etc. Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations">Threading Recommendations</a> (in progress) </hint> </question>
-->
<answer id="exec-threading">
<p>
Threading model of the EditorDocument adheres to javax.swing.text.Document
interface. There can be multiple reader threads accessing
the document simultaneously but only one mutating thread at the time.
</p>
<p>
All the UI-related tasks adhere to Swing/AWT conventions i.e. they
must be performed in EQ thread.
</p>
</answer>
<!-- <question id="perf-spi" when="init"> How the performance of the plugged in code will be enforced? <hint> If you allow foreign code to be plugged into your own module, how do you enforce, that it will behave correctly and fast and will not negatively influence the performance of your own module? </hint> </question>
-->
<answer id="perf-spi">
The infrastructure does not enforce any performance criteria and it's up to
modules to perform reasonably. On the other hand each SPI defines its threading
and locking model, which should help modules to understand the constraints
and impact of their code.
</answer>
<!-- <question id="security-grant" when="final"> Does your code grant additional rights to some other code? <hint>Avoid using a class loader that adds extra permissions to loaded code unless really necessary. Also note that your API implementation can also expose unneeded permissions to enemy code by calling AccessController.doPrivileged().</hint> </question>
-->
<answer id="security-grant">
No.
</answer>
<!-- <question id="security-policy" when="final"> Does your functionality require modifications to the standard policy file? <hint>Your code might pass control to third-party code not coming from trusted domains. This could be code downloaded over the network or code coming from libraries that are not bundled with NetBeans. Which permissions need to be granted to which domains?</hint> </question>
-->
<answer id="security-policy">
No.
</answer>
<!-- <question id="exec-ant-tasks" when="impl"> Do you define or register any ant tasks that other can use? <hint> If you provide an ant task that users can use, you need to be very careful about its syntax and behaviour, as it most likely forms an API for end users and as there is a lot of end users, their reaction when such API gets broken can be pretty strong. </hint> </question>
-->
<answer id="exec-ant-tasks">
No.
</answer>
<!-- <question id="compat-deprecation" when="init"> How the introduction of your project influences functionality provided by previous version of the product? <hint> If you are planning to deprecate/remove/change any existing APIs, list them here accompanied with the reason explaining why you are doing so. </hint> </question>
-->
<answer id="compat-deprecation">
The APIs and SPIs in editor/lib2 module should become offical replacements
for the legacy editor APIs that do not conform with the Netbeans API standards.
</answer>
<!-- <question id="resources-preferences" when="final"> Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ? <hint> You may use <pre xml:space="preserve"> <api type="export" group="preferences" name="preference node's absolute path name" category="private" url="http://..."> description of individual keys, where it is used, what it influence, whether the module reads/write it, etc. </api> </pre> </hint> </question>
-->
<answer id="resources-preferences">
No.
</answer>
</api-answers>
¤ Dauer der Verarbeitung: 0.20 Sekunden
(vorverarbeitet)
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.
