|
|
|
|
|
|
|
|
This module provides API (read more) that works on top of file objects and gives each file a logical behaviour - icon, name, operations, etc.
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: A lot of usecases is described in the javadoc. Here is the list of some faqs:Often many people require ability to create a "clever" template - e.g. write piece of simple text and at the time of its processing do some advanced changes to it using either scripting or templating languages.
This traditionally used to be a bit complicated task, however since version 6.1 there are new interfaces org.openide.loaders.CreateFromTemplateHandler - can be registered as a services in a lookup and it is reponsible for handling the whole copy of the template file(s) to the destination folder. and org.openide.loaders.CreateFromTemplateAttributesProvider - can be registered as a services in a lookup and it is reponsible for providing "hints" - e.g. map mapping strings to various objects. and these interfaces allow anyone to extend the behaviour during creation of new files without writing new DataLoader and co.
The support was moved to a new module; please see api.templates module for more information.
Loaders/folder/any/Actions
so if any module wishes
to extend, hide or reorder some of them it can just register its actions there.
As code like this does:
<folder name="Loaders" >
<folder name="folder" >
<folder name="any" >
<folder name="Actions" >
<file name="org-mymodule-MyAction.instance" >
<attr name="instanceCreate" stringvalue="org.mymodule.MyAction" />
</file>
</folder>
</folder>
</folder>
</folder>
As described in general
actions registration tutorial.
This functionality is available since version 5.0 of the loaders module. Please use
OpenIDE-Module-Module-Dependencies: org.openide.loaders > 5.0 in your
module dependencies.
In version 5.8 all the standard loaders were changed to read actions from layer:
Loaders/text/xml/Actions
Loaders/content/unknown/Actions
Loaders/application/x-nbsettings/Actions
DataObjects produced by your DataLoader and you
are either using DataNode or its subclass, you can just override
protected String actionsContext() method to return non-null
location of context in layers from where to read the actions.
The usual value should match Loaders/mime/type/Actions scheme,
for example java is using Loaders/text/x-java/Actions, but
the name can be arbitrary.
This functionality is available since version 5.0 of the loaders module. Please use
OpenIDE-Module-Module-Dependencies: org.openide.loaders > 5.0 in your
module dependencies.
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:
No.
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:
Loaders-mime-type-Factories
-
Loaders are registered in the layer in folder Loaders/mime/type/Factories.
Yes, module creates the folders in layer org/netbeans/core/ui/resources/layer.xml in core-ui.jar. The folders are instrumental to store information about used templates. Provided folders:
The main menu of the application is composed by reading Menu/
folder in the layer. A sub folder is treated as a sub menu.
Instances of individual files (usually .instance
or .shadow) may then represent Action
or JMenuItem
or JSeparator.
Since version 7.44 one can attach property-prefix attribute
to every folder. Then all the file attributes are scanned and if some
of them start with the specified prefix they are placed a
client
properties on the JMenu
instance (after stripping the prefix off).
None of them is forced to found.
Question (resources-read): Does your module read any resources from layers? For what purpose? Answer: NewTemplateAction reads a list of templates from folders Privileged and Recent. This list is exposed in a popup menu. 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:
org.openide.actions.FileSystemRefreshAction.manual
-
If NbPreferences.root().node("org/openide/actions/FileSystemRefreshAction").getBoolean("manual", false)
returns true, then FileSystemRefreshAction
is displayed in popup menu of folders.
org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
If there is no DataLoaderPool available in default
lookup, the fallback is to use a simple loader pool that contains
just the fixed system
loaders, and any
DataLoaders that can be found in default lookup.
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:
org.xml.sax.driver
-
This is a standard way to find a class of a SAX2 driver. See
SAX2 documentation
netbeans.profile.memory
-
Boolean.TRUE means to dettach from shared impl of parser, it is static!?
org.openide.loaders.FolderList.refresh.interval
-
The value of type integer determines the number of milliseconds
between successive refreshes of contents of a folder. Can be used to tweak
performance of folder refresh. Defaults to 10.
netbeans.dataobject.insecure.operation
-
If set to true, the DataObject.copy, move, createFromTemplate
are executed in insecure way. That means that other threads can access the
products of such operation before it finishes. This is a friend contract
with projects, that need to do such strange things. Will be removed when they
fix it.
Nb.Explorer.Folder.icon
-
Icon or Image for closed folder.
Nb.Explorer.Folder.openedIcon
-
Icon or Image for opened folder.
Tree.openedIcon
-
Fallback Icon or Image for opened folder.
Tree.closedIcon
-
Fallback Icon or Image for folder.
wizard.anything
-
When TemplateWizard invokes
DataObject.createFromTemplate,
it passes as argument all its properties
to it with prefix wizard.. That way they are available to
underlaying scripting and templating
engines.
org.netbeans.modules.openide.loaders.ASK_OnSaving
-
Control on save yes/no dialog in
DataEditorSupport
by setting the ASK_OnSaving key in
org/netbeans/modules/openide/loaders/Bundle.properties
to yes or no in a branding file in your application.
org.netbeans.modules.openide.loaders.ASK_OnClosing
-
Control on close yes/no dialog in
DataEditorSupport
by setting the ASK_OnClosing key in
org/netbeans/modules/openide/loaders/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 data system stores some of its vital information in file attributes. Those
attributes are accessible via calls to
org.openide.filesystems.FileObject.getAttribute(name)
org.openide.filesystems.FileObject.setAttribute(name, value)
They can also be stored in the module layer. Please see filesystems
for more information about this.
NetBeansAttrAssignedLoader
-
Extended attribute for holding the class of the loader that should
be used to recognize a file object before the normal processing takes
place.
NetBeansAttrAssignedLoaderModule
-
Extended attribute which may be used in addition to EA_ASSIGNED_LOADER
which indicates the code name base of the module that installed that preferred
loader. If the indicated module is not installed, ignore the loader request.
See #13816.
template
-
If set to Boolean.TRUE the file is recognized as template and
its instantiation is allowed.
isRemoteAndSlow
-
If the file attribute isRemoteAndSlow is true on a folder,
the New File wizard will avoid asking for its children.
templateWizardURL
-
Attribute that defines a template wizard description page (type URL to HTML).
templateWizardIterator
-
Attribute that defines a custom template wizard iterator (type TemplateWizard.Iterator).
originalFile
-
Path to the target file in its filesystem (type String).
originalFileSystem
-
System name of filesystem of target file (type String; default is same as that of shadow).
UseOwnName
-
if true, the DataShadow name is used instead of original's name,
affects DataShadows of filesystem roots only
simple
-
templates and folders under Templates/
folder can be annotated with <attr name="simple" boolvalue="false"<
if they are supposed to be hidden in Template Manager.
If a folder is annotated with this attribute, it is also hidden
in standard New File wizard.
PartialOrders
-
Read the list of intended partial orders from disk.
Each element is a string of the form a/b for a, b filenames
with extension, where a should come before b.
The value of the attribute must be of type Boolean; ignored unless true.
OpenIDE-Folder-SortMode
-
Extended attribute for order of children. The values
are "F", "N", "C", "0" (type String).
OpenIDE-Folder-Order
-
Extended attribute for order of children - stores list
of file names separated by '/' (type String).
org.openide.loaders.FolderChildren.delayedCreation
-
Since 7.25 the DataFolder.getNodeDelegate() tries to prevent
creation of DataObject
in AWT dispatch thread. Rather it creates dummy node with name
derived from the name of the file and simplified content of lookup:
The creation of real node is scheduled to background and as soon as the DataObject and its Node are ready, the initial dummy node is replaced by the real one.
This whole system is slightly incompatible and may complicate creation
of filtered views over the node hierarchy (one needs to be ready to
really dynamics changes). That is why it is possible to disable
the new delayed
system by starting the system with
-Dorg.openide.loaders.FolderChildren.delayedCreation=false.
Use this property as a temporary fix for your problems, but consider
fixing your code to support the delayed mode
in the future.
ConnectionCookie.
DataFolder.Index.reorderable
-
If set to Boolean.TRUE on a folder not in the system filesystem, make its node reorderable.
expectedTime
-
When the DataObject is moved to new location, we
we need to adjust the time to the new file object.
CloneableEditorSupport
exports special "expectedTime" property for this purpose. Tested
in DataEditorSupportTest.testChangeFileWhileOpen.
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:XXX no answer for exec-reflection
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection? Answer:XXX no answer for exec-privateaccess
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:XXX no answer for exec-process
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof,
work with java.lang.Class, etc.)?
Answer:
No.
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:
We use following MIME type:
application/x-java-openide-dataobjectdnd;class=org.openide.loaders.DataObject;mask={0}
XXX no answer for perf-spi