Datasystems are the logical layer between a filesystem and higher-level file-oriented operations.
This module provides API (read more) that works on top of file objects and gives each file a logical behaviour - icon, name, operations, etc.
Now it's possible to register actions with toggle property into Toolbar to get a toggle button.
Oct 21 '15 Introduces SortMode for natural sorting.
Added support for natural sorting of DataObjects. This means that the sort is case insensitive and number sequences are sorted by value rather than lexicographically.
Template handling need not depend on Data System APIs, should be available for clients that only know FileSystems. Relevant interfaces moved to openide.filesystems.templates module; see javadoc for FileBuilder for details.
Jan 29 '14 Introduce targetName for templates.
By default, files created from templates have name preinitialized to "new" + template name. TemplateRegistration.targetName can be used to customize how the file name will be preinitialized.
Oct 10 '13 Introduces SortMode for sorting by file extension.
It's possible to sort files using sort mode "By Type", which means using SortMode.CLASS. It may be confusing, as users expect that the files will be sorted by file type, i.e. by extension. "By Type" was renamed to "By Class" and new sort mode "By Extension" (SortMode.EXTENSIONS) was added.
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 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 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.
How to add action to folder's popup menu?
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.
How to allow others to enhance actions of your loader?
If you want other modules to enhance or modify actions that are visible on 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.
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.
can be registered as a services in a lookup and it is reponsible for providing "hints" - e.g. map mapping strings to various objects.
The actions that the default folder loader shows in its popup menu are read from a layer folder Loaders/folder/any/Actions so if any module wishes to extend, hide or reorder some of them it can just register its actions there.
Loaders are registered in the layer in folder Loaders/mime/type/Factories.
A folder Privileged offers to other module possibility add own templates.
A folder Recent stores a set of recently used templates, it's not open to other module.
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).
Extended attribute for holding the class of the loader that should be used to recognize a file object before the normal processing takes place.
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.
If set to Boolean.TRUE the file is recognized as template and its instantiation is allowed.
If the file attribute isRemoteAndSlow is true on a folder, the New File wizard will avoid asking for its children.
Attribute that defines a template wizard description page (type URL to HTML).
Attribute that defines a custom template wizard iterator (type TemplateWizard.Iterator).
Path to the target file in its filesystem (type String).
System name of filesystem of target file (type String; default is same as that of shadow).
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.
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.
Extended attribute for order of children. The values are "F", "N", "C", "0" (type String).
Extended attribute for order of children - stores list of file names separated by '/' (type String).
Extended attribute to store (ArrayList of Type and Node.Handle). Used by Java synchronization feature at least; generally, ConnectionCookie.
If set to Boolean.TRUE on a folder not in the system filesystem, make its node reorderable.
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.
DataObject - created on the fly, very inefficient, if requested from AWT dispatch thread, it prints a warning. Consider using just FileObject.
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.
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.
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.
Icon or Image for closed folder.
Icon or Image for opened folder.
Fallback Icon or Image for opened folder.
Fallback Icon or Image for folder.
If NbPreferences.root().node("org/openide/actions/FileSystemRefreshAction").getBoolean("manual", false) returns true, then FileSystemRefreshAction is displayed in popup menu of folders.