|
|
|
|
XXX no answer for arch-overall
Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module? Answer:XXX no answer for arch-usecases
Question (arch-time): What are the time estimates of the work? Answer:XXX no answer for arch-time
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented? Answer:XXX no answer for arch-quality
Question (arch-where): Where one can find sources for your module? Answer:
The sources for the module are in the Apache Git repositories or in the GitHub repositories.
The default answer to this question is:
These modules are required in project.xml:
XXX no answer for deploy-dependencies
XXX no answer for compat-deprecation
java.io.File directly?
Answer:
Yes, for showing absolute filename path in the tooltip.
Question (resources-layer):
Does your module provide own layer? Does it create any files or
folders in it? What it is trying to communicate by that and with which
components?
Answer:
No.
Question (resources-read):
Does your module read any resources from layers? For what purpose?
Answer:
Editors-TabActions
-
Actions for the editor tab (window) context menu can be injected into Editors/TabActions.
Question (resources-mask):
Does your module mask/hide/override any resources provided by other modules in
their layers?
Answer:
No.
Question (resources-preferences):
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 ?
Answer:
XXX no answer for resources-preferences
org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
Yes, it looks for IndentEngine service type class. This class is defined in
this module. The first one indentation engine found for the given MIME is returned.
Others are ignored.
Question (lookup-register):
Do you register anything into lookup for other code to find?
Answer:
No.
Question (lookup-remove):
Do you remove entries of other modules from lookup?
Answer:
No.
System.getProperty) property?
On a similar note, is there something interesting that you
pass to java.util.logging.Logger? Or do you observe
what others log?
Answer:
oldInitialization
-
As the speedup of startup done in version 6.18 is not fully compatible,
there is a way to get back the original behaviour: just use
this.putClientProperty("oldInitialization", Boolean.TRUE)
and the whole initialization will be done in AWT thread. This is generally
slower, but compatible.
org.openide.text.CloneableEditor.oldInitialization
-
In order to measure startup improvements between AWT and non-AWT startup,
we have a property dedicated to testing that can switch all editors to be
opened in AWT. Just start NetBeans with
-J-Dorg.openide.text.CloneableEditor.oldInitialization=true.
This property may be discontiued anytime.
org.netbeans.modules.openide.text.ASK_OnReload
-
Control on reload yes/no dialog in
CloneableEditorSupport
by setting the ASK_OnReload key in
org/netbeans/modules/openide/text/Bundle.properties
to yes or no in a branding file in your application.
Question (exec-component):
Is execution of your code influenced by any (string) property
of any of your components?
Answer:
The module can be influencend by this property:
indentEngine
-
Property hold instance of IndentEngine
and this indentation engine is used instead of system one.
It set these Swing properties:
javax.swing.text.Document.StreamDescriptionProperty
-
Property hold instance of DataObject
from which the document was created. This property can be used by the modules and is part of the Editor API.
javax.swing.text.Document.TitleProperty
-
Property hold instance of String with name of the file being edited.
This property can be used by the modules and is part of the Editor API.
javax.swing.text.Document.modificationListener
-
In order to fix issue 51872 the
openide needs a way how to be notified about change of a document outside of its Document lock.
DocumentListeners are always notified under the lock, so a special contract has
been established (since version 5.3) by registering an instance of VetoableListener
by calling putProperty ("modificationListener", listener). The
NetBeans aware documents are adviced to honor this property and call the listener
outside of the document lock when a modification is made. The actual contract
of the call can be seen in
NbLikeEditorKit.java
in methods
insertString and remove.
beforeSaveRunnable
-
Document property that allows to execute a runnable before save of a document is performed.
For example an extra whitespace accumulated during typing can be removed by exploiting this property.
expectedTime
-
CloneableEditorSupport
understands not only its Env.TIME property, but also special
"expectedTime". When this one arrives, it means refresh its internal
last saved time, but without any refresh. This functionality is used from
DataEditorSupport when the DataObject is moved to new location
and we need to adjust the time to the new file object.
usedByCloneableEditor
-
Component client property which is set to Boolean.TRUE if an editor pane is actively used by a cloneable editor.
Once the component gets closed the CloneableEditor sets the property to Boolean.FALSE.
Question (exec-ant-tasks):
Do you define or register any ant tasks that other can use?
Answer:
XXX no answer for exec-ant-tasks
Question (exec-classloader): Does your code create its own class loader(s)? Answer: No. Question (exec-reflection): Does your code use Java Reflection to execute other code? Answer: Yes, it calls protected method MultiDataObject.getCookieSet(). The class which calls this is deprecated, but it is still in use by clients. Another reflection is used in QuietEditorPane, where DelegatingTransferHandler delegates also on two protected methods of TransferHandler:createTransferable and
exportDone. This delegation is needed because of drag and drop feature described
in issue #53439
Question (exec-privateaccess):
Are you aware of any other parts of the system calling some of
your methods by reflection?
Answer:
EditorKitInitialization
-
In order to speedup, or remove the load of initialization of kit in AWT during startup,
there is a special API that allows to ask the kit to pre-initialize. If the kit
implements Callable interface from JDK, it is called in non-AWT thread.
This works since version 6.18 and can be disabled by property oldInitialization.
Question (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?
Answer:
No.
Question (exec-introspection):
Does your module use any kind of runtime type information (instanceof,
work with java.lang.Class, etc.)?
Answer:
The Editor module operate with plain Swing Document in
its APIs and checks whether the document does not implement some of the Netbeans extensions defined in
NbDocument.
It also tries to retype CloneableTopComponent.Ref.getComponents()
to its CloneableEditor. If some document does not implement
StyledDocument,
it is wrapped into FilterDocument which implements limited StyledDocument functionality.
Question (exec-threading):
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
Answer:
XXX no answer for exec-threading
Question (security-policy): Does your functionality require modifications to the standard policy file? Answer:XXX no answer for security-policy
Question (security-grant): Does your code grant additional rights to some other code? Answer:XXX no answer for security-grant
java.awt.datatransfer.Transferable?
Answer:
None.
XXX no answer for perf-spi