| Package | Description |
|---|---|
| org.openide.actions | |
| org.openide.loaders |
Datasystems
are the logical layer between a filesystem and higher-level file-oriented operations.
|
| org.openide.text |
| Modifier and Type | Method and Description |
|---|---|
static Set<DataObject> |
InstantiateAction.instantiateTemplate(DataObject obj)
Deprecated.
Instantiate a template object.
|
| Modifier and Type | Method and Description |
|---|---|
static Set<DataObject> |
InstantiateAction.instantiateTemplate(DataObject obj)
Deprecated.
Instantiate a template object.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DataFolder
A folder containing data objects.
|
class |
DataShadow
Default implementation of a shortcut to another data object.
|
class |
InstanceDataObject
A data object whose only purpose is to supply
InstanceCookie. |
class |
MultiDataObject
Provides support for handling of data objects with multiple files.
|
class |
XMLDataObject
Object that provides main functionality for xml documents.
|
| Modifier and Type | Method and Description |
|---|---|
static <T extends DataObject> |
DataLoaderPool.factory(Class<T> dataObjectClass,
String mimeType,
Image image)
Factory method to create default implementation of a factory for
data objects.
|
| Modifier and Type | Method and Description |
|---|---|
DataObject |
DataObject.copy(DataFolder f)
Copy this object to a folder.
|
DataObject |
DataObject.createFromTemplate(DataFolder f)
Create a new object from template (with a name depending on the template).
|
DataObject |
DataObject.createFromTemplate(DataFolder f,
String name)
Create a new object from template.
|
DataObject |
DataObject.createFromTemplate(DataFolder f,
String name,
Map<String,? extends Object> parameters)
More generic way how to instantiate a
DataObject. |
protected static DataObject |
DataShadow.deserialize(FileObject fileObject)
Tries to load the original file from a shadow.
|
static DataObject |
DataObject.find(FileObject fo)
Finds the data object for a specified file object.
|
DataObject |
DataLoaderPool.findDataObject(FileObject fo)
Find a data object for this file object (not for normal users of the APIs).
|
DataObject |
DataLoader.findDataObject(FileObject fo,
DataLoader.RecognizedFiles recognized)
Find a data object appropriate to the given file object--the meat of this class.
|
DataObject |
DataLoaderPool.findDataObject(FileObject fo,
DataLoader.RecognizedFiles r)
Find a data object for this file object, considering already-recognized files (not for normal users of the APIs).
|
DataObject |
DataLoader.findDataObject(FileObject fo,
Set<? super FileObject> recognized)
Find a data object appropriate to the given file object--the meat of this class.
|
DataObject |
DataObject.Factory.findDataObject(FileObject fo,
Set<? super FileObject> recognized)
Find a data object appropriate to the given file object--the meat of this class.
|
DataObject[] |
DataShadow.getChildren()
Implementation of Container interface.
|
DataObject[] |
DataObject.Container.getChildren() |
DataObject[] |
DataFolder.getChildren()
Get the children of this folder.
|
DataObject |
DataObjectExistsException.getDataObject()
Get the object which already exists.
|
protected DataObject |
OpenSupport.Env.getDataObject()
Getter for data object.
|
DataObject |
DataNode.getDataObject()
Get the represented data object.
|
static DataObject |
LoaderTransfer.getDataObject(Transferable t,
int action)
Obtain a DataObject from a transferable.
|
static DataObject[] |
LoaderTransfer.getDataObjects(Transferable t,
int action)
Obtain a list of DataObjects from a transferable.
|
DataObject[] |
DataObject.Registry.getModified()
Get modified objects.
|
DataObject |
OperationEvent.getObject()
Get the data object that has been modified.
|
DataObject |
DataShadow.getOriginal()
Return the original shadowed object.
|
DataObject |
OperationEvent.Copy.getOriginalDataObject()
Get the original data object.
|
DataObject |
TemplateWizard.getTemplate()
Getter for template to create object from.
|
protected DataObject |
InstanceDataObject.handleCopy(DataFolder df) |
protected DataObject |
DataShadow.handleCopy(DataFolder f) |
protected abstract DataObject |
DataObject.handleCopy(DataFolder f)
Copy this object to a folder (implemented by subclasses).
|
protected DataObject |
MultiDataObject.handleCopy(DataFolder df)
Copies primary and secondary files to new folder.
|
protected DataObject |
DataFolder.handleCopy(DataFolder f) |
protected DataObject |
DataObject.handleCopyRename(DataFolder f,
String name,
String ext)
Copy and rename this object to a folder (implemented by subclasses).
|
protected DataObject |
MultiDataObject.handleCopyRename(DataFolder df,
String name,
String ext) |
protected DataObject |
InstanceDataObject.handleCreateFromTemplate(DataFolder df,
String name) |
protected abstract DataObject |
DataObject.handleCreateFromTemplate(DataFolder df,
String name)
Create a new data object from template (implemented in subclasses).
|
protected DataObject |
MultiDataObject.handleCreateFromTemplate(DataFolder df,
String name) |
protected DataObject |
DataFolder.handleCreateFromTemplate(DataFolder f,
String name) |
protected abstract DataObject |
DataLoader.handleFindDataObject(FileObject fo,
DataLoader.RecognizedFiles recognized)
Find a data object appropriate to the given file object (as implemented in subclasses).
|
protected DataObject |
MultiFileLoader.handleFindDataObject(FileObject fo,
DataLoader.RecognizedFiles recognized) |
| Modifier and Type | Method and Description |
|---|---|
Enumeration<DataObject> |
DataFolder.children()
Get enumeration of children of this folder.
|
Enumeration<DataObject> |
DataFolder.children(boolean rec)
Enumerate all children of this folder.
|
Set<DataObject> |
DataObject.Registry.getModifiedSet()
Get a set of modified data objects.
|
Class<? extends DataObject> |
DataLoader.getRepresentationClass()
Get the representation class for this data loader, as passed to the constructor.
|
protected Set<DataObject> |
TemplateWizard.handleInstantiate()
Calls iterator's instantiate.
|
Set<DataObject> |
TemplateWizard.instantiate()
Chooses the template and instantiates it.
|
Set<DataObject> |
TemplateWizard.instantiate(DataObject template)
Chooses the template and instantiates it.
|
Set<DataObject> |
TemplateWizard.instantiate(DataObject template,
DataFolder targetFolder)
Chooses the template and instantiates it.
|
Set<DataObject> |
TemplateWizard.Iterator.instantiate(TemplateWizard wiz)
Instantiates the template using information provided by
the wizard.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
DataFilter.acceptDataObject(DataObject obj)
Should the data object be displayed or not?
|
protected InstanceCookie |
FolderInstance.acceptDataObject(DataObject dob)
Allows subclasses to decide whether they want to work with the specified
DataObject or not. |
Map<String,?> |
CreateFromTemplateAttributesProvider.attributesFor(DataObject template,
DataFolder target,
String name)
Deprecated.
Called when a template is about to be instantiated to provide additional
values to the
CreateFromTemplateHandler that will handle the
template instantiation. |
static DataShadow |
DataShadow.create(DataFolder folder,
DataObject original)
Method that creates new data shadow in a folder.
|
static DataShadow |
DataShadow.create(DataFolder folder,
String name,
DataObject original)
Method that creates new data shadow in a folder.
|
static DataShadow |
DataShadow.create(DataFolder folder,
String name,
DataObject original,
String ext)
Method that creates new data shadow in a folder.
|
static Lookup |
Environment.find(DataObject obj)
Finds a lookup for given data object.
|
static Context |
Environment.findSettingsContext(DataObject obj)
Deprecated.
This method is probably unused and useless.
|
static URL |
TemplateWizard.getDescription(DataObject obj)
Method to get a description for a data object.
|
static String |
TemplateWizard.getDescriptionAsResource(DataObject obj)
Deprecated.
|
Lookup |
Environment.Provider.getEnvironment(DataObject obj)
Returns a lookup that represents environment.
|
static TemplateWizard.Iterator |
TemplateWizard.getIterator(DataObject obj)
Finds a custom iterator attached to a template that should
be used to instantiate the object.
|
protected Object |
FolderLookup.instanceForCookie(DataObject dobj,
InstanceCookie cookie)
Deprecated.
Overrides superclass method.
|
protected Object |
FolderInstance.instanceForCookie(DataObject obj,
InstanceCookie cookie)
Method that is called when a the folder instance really wants to
create an object from provided cookie.
|
Set<DataObject> |
TemplateWizard.instantiate(DataObject template)
Chooses the template and instantiates it.
|
Set<DataObject> |
TemplateWizard.instantiate(DataObject template,
DataFolder targetFolder)
Chooses the template and instantiates it.
|
static void |
TemplateWizard.setDescription(DataObject obj,
URL url)
Method to attach a description to a data object.
|
static void |
TemplateWizard.setDescriptionAsResource(DataObject obj,
String rsrc)
Deprecated.
|
static void |
TemplateWizard.setIterator(DataObject obj,
TemplateWizard.Iterator iter)
Deprecated.
since 2.13 you should provide the iterator from
getCookie method |
void |
DataFolder.setOrder(DataObject[] arr)
Set the order of the children.
|
void |
TemplateWizard.setTemplate(DataObject obj)
Sets the template.
|
static ExTransferable.Single |
LoaderTransfer.transferable(DataObject d,
int actions)
Creates transferable that represents an operation, such as cut-to-clipboard.
|
| Modifier and Type | Method and Description |
|---|---|
DataLoader |
DataLoaderPool.firstProducerOf(Class<? extends DataObject> clazz)
Finds the first producer of a representation class.
|
Enumeration<DataLoader> |
DataLoaderPool.producersOf(Class<? extends DataObject> clazz)
Get an enumeration of all producers of a representation class.
|
| Constructor and Description |
|---|
DataNode(DataObject obj,
Children ch)
Create a data node with the given children set for the given data object.
|
DataNode(DataObject obj,
Children ch,
Lookup lookup)
Create a data node for a given data object.
|
DataObjectExistsException(DataObject obj)
Create new exception.
|
DataShadow(FileObject fo,
DataObject original,
DataLoader loader)
Deprecated.
Since 1.13 do not use this constructor, it is for backward compatibility only
|
DataShadow(FileObject fo,
DataObject original,
MultiFileLoader loader)
Constructs new data shadow for given primary file and referenced original.
|
Env(DataObject obj)
Constructor.
|
| Constructor and Description |
|---|
DataLoader(Class<? extends DataObject> representationClass)
Deprecated.
Use
DataLoader(String) instead. |
MultiFileLoader(Class<? extends DataObject> representationClass)
Deprecated.
Use MultiFileLoader#MultiFileLoader(String) instead.
|
UniFileLoader(Class<? extends DataObject> representationClass)
Deprecated.
Use UniFileLoader#UniFileLoader(String) instead.
|
| Modifier and Type | Field and Description |
|---|---|
protected DataObject |
EditorSupport.Editor.obj
data object to work with
|
| Modifier and Type | Method and Description |
|---|---|
static DataObject |
DataEditorSupport.findDataObject(Line l)
Support method that extracts a DataObject from a Line.
|
DataObject |
DataEditorSupport.getDataObject()
Getter of the data object that this support is associated with.
|
| Modifier and Type | Method and Description |
|---|---|
static CloneableEditorSupport |
DataEditorSupport.create(DataObject obj,
MultiDataObject.Entry entry,
CookieSet set)
Factory method to create simple CloneableEditorSupport for a given
entry of a given DataObject.
|
static CloneableEditorSupport |
DataEditorSupport.create(DataObject obj,
MultiDataObject.Entry entry,
CookieSet set,
Callable<CloneableEditorSupport.Pane> paneFactory)
Factory method to create a bit more complicated CloneableEditorSupport for a given
entry of a given DataObject.
|
| Constructor and Description |
|---|
DataEditorSupport(DataObject obj,
CloneableEditorSupport.Env env)
Editor support for a given data object.
|
DataEditorSupport(DataObject obj,
Lookup lkp,
CloneableEditorSupport.Env env)
Editor support for given data object.
|
Editor(DataObject obj)
Constructor
|
Editor(DataObject obj,
EditorSupport support)
Constructor
|
Env(DataObject obj)
Constructor.
|