| org.netbeans.modules.vmd.api.model |
|
Description and use-cases for:
TypeID, PropertyValue
DescriptorRegistry, ComponentDescriptor
DesignDocument, DesignComponent
TransactionManager
ListenerManager
PrimitiveDescriptor
EnumDescriptor
AccessContoller
What happens when:
Document serialization / deserialization
Registry is changed + Component with missing descriptor
|
| Java Source File Name | Type | Comment |
| AccessController.java | Interface | This interface is used for notifying and processing event firing.
For registering the implemenation see AccessControllerFactory interface.
Event firing is following these steps: For all registered AccessController classes a writeAccess method is called
by nested calls (passing the calls using Runnable). |
| AccessControllerFactory.java | Interface | Register an implementation of this interface into global lookup (META-INF/services/org.netbeans.modules.vmd.api.model.AccessControllerFactory file). |
| AccessControllerFactoryRegistry.java | Class | |
| AccessControllerTest.java | Class | |
| ComponentDescriptor.java | Class | This class represents a component descriptor. |
| ComponentProducer.java | Class | Represents a factory for components. |
| ComponentSerializationSupport.java | Class | This class contains a support for a custom component serialization into a xml file which is automatically stored into the global registry. |
| Debug.java | Class | This class is in the API for debugging purpose only. |
| DescriptorRegistry.java | Class | This class represents a registry for all component descriptors that could be used in the document. |
| DescriptorRegistryListener.java | Interface | |
| DescriptorRegistryTest.java | Class | |
| DesignComponent.java | Class | This class represents a component in a document. |
| DesignComponentTest.java | Class | |
| DesignDocument.java | Class | This class represents a document holding all components.
For creating document it is required to define a relation to a project when the document will exists.
This is important resolving a repository of project-dependant component descriptors and classpath.
The document contains a transaction manager. |
| DesignDocumentTest.java | Class | |
| DesignEvent.java | Class | The class represents a document change event. |
| DesignEventFilter.java | Class | This class represents an event filter. |
| DesignEventTest.java | Class | |
| DesignListener.java | Interface | This class represents a listeners used for notifying that a document is changed. |
| DestructiveTest.java | Class | |
| DocumentInterface.java | Interface | This interface defines the project and allows the model API to be independant on any project/loaders infrastructure. |
| DynamicPresenter.java | Class | This presenter is designed to allow receiving notification about document changes.
When a presenter is really attached to a component, then notifyAttached method is called to notify it. |
| EnumDescriptor.java | Interface | This interface is used for describing (de)serialization and valid values of a design-time enums (for TypeID.Kind == ENUM). |
| EnumDescriptorFactory.java | Interface | Register an implementation of this interface into global lookup (META-INF/services/org.netbeans.modules.vmd.api.model.EnumDescriptorFactory file). |
| EnumDescriptorFactoryRegistry.java | Class | |
| GlobalDescriptorRegistry.java | Class | |
| GlobalDescriptorRegistryTest.java | Class | |
| ListenerManager.java | Class | This class managers listeners and cares about firing an events.
The approach behind the listener manager are group listeners. |
| ListenerManagerTest.java | Class | |
| PaletteDescriptor.java | Class | This immutable class represents a palette descriptor used in component descriptor. |
| PaletteDescriptorTest.java | Class | |
| PostInitializeProcessor.java | Class | |
| Presenter.java | Class | This class is designed for a privilege access to component. |
| PresenterDeserializer.java | Class | Used for deserialization of 3rd-party defined nodes in a component descriptor serialized as an xml file in component registry. |
| PresenterEvent.java | Interface | This interface represents a presenter-changed event. |
| PresenterEventManager.java | Class | |
| PresenterListener.java | Interface | This interface defines a presenter listener. |
| PresenterSerializer.java | Interface | This interface is used as an input parameter for ComponentSerializationSupport.serialize method
and allows to specify serialization of custom presenters. |
| PresentersProcessor.java | Class | |
| PresenterTest.java | Class | |
| PrimitiveDescriptor.java | Interface | This interface is used for describing (de)serialization of a design-time primitives (for TypeID.Kind == PRIMITIVE). |
| PrimitiveDescriptorFactory.java | Interface | Register an implementation of this interface into global lookup (META-INF/services/org.netbeans.modules.vmd.api.model.PrimitiveDescriptorFactory file). |
| PrimitiveDescriptorFactoryRegistry.java | Class | |
| ProducerDeserializer.java | Class | Used for processing custom producers defined as an xml file in component registry. |
| PropertiesProcessor.java | Class | |
| PropertyDescriptor.java | Class | This immutable class represents a property descriptor used in component descriptor. |
| PropertyDescriptorTest.java | Class | |
| PropertyValue.java | Class | This immutable class represents a property value.
This class holds information about kind, type id, user code, component, value, array.
The kind could be user code, null, component reference, non-array value, enum value, array value.
This type id represents the type id of the property value for all kinds expect user code and null value.
This user code holds the text of the user code in target language. |
| PropertyValueArrayTest.java | Class | |
| PropertyValueSupport.java | Class | |
| PropertyValueTest.java | Class | |
| TransactionManager.java | Class | This class manages a transactional access to a document. |
| TypeDescriptor.java | Class | This immutable class describes the type hierarchy used in component descriptor. |
| TypeDescriptorTest.java | Class | |
| TypeID.java | Class | This immutable class represents a type of objects/components in the model. |
| TypeIDTest.java | Class | |
| Versionable.java | Interface | This interface represents a version resolver. |
| VersionDescriptor.java | Interface | This inteface defines a version compatibility and convertions. |