Java Doc for DesignDocument.java in  » IDE-Netbeans » vmd.analyzer » org » netbeans » modules » vmd » api » model » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Netbeans » vmd.analyzer » org.netbeans.modules.vmd.api.model 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.netbeans.modules.vmd.api.model.DesignDocument

DesignDocument
final public class DesignDocument (Code)
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. It allows you to acquire a read or write access to the document. It is because almost all method in the model API is protected and you have to have an appropriate access to call them. The manager uses NetBeans MUTEX class that allows to multi-read or single-write access at the same time.

The document does not fire an event everytime you change something in the document and it does not allows you to register a listener on each component directly. Instead there is a listener manager which groups all events from the all parts of document and fires a single big event when a write transaction is finished. The listener manager allows you to register document-related event listeners with a specific event filter.

The document contain a tree of component. The tree is specified by a root component. The root component could be set only once.
author:
   David Kaspar




Constructor Summary
public  DesignDocument(DocumentInterface documentInterface)
     Creates an instance of document.

Method Summary
public  DesignComponentcreateComponent(TypeID componentType)
     Creates a new component using a component descriptor with specified typeid.
public  DesignComponentcreateRawComponent(TypeID componentType)
     Creates a new raw component using a component descriptor with specified typeid.
public  voiddeleteComponent(DesignComponent component)
     Removes a component from the component tree and removes references to this component from all property values in all components in the document.
public  voiddeleteComponents(Collection<DesignComponent> components)
     Removes components from the component tree and removes references to these components from all property values in all components in the document.
public  DesignComponentgetComponentByUID(long componentID)
     Returns a component with specified component id.
public  DescriptorRegistrygetDescriptorRegistry()
     Returns a component descriptor registry related to the project when the document is placed.
public  DocumentInterfacegetDocumentInterface()
     Returns document interface of the document.
public  ListenerManagergetListenerManager()
     Returns a listener manager of the document.
public  DesignComponentgetRootComponent()
     Returns a root component of components tree assigned to the document.
public  Collection<DesignComponent>getSelectedComponents()
     Returns a set of selected components.
public  StringgetSelectionSourceID()
     Returns an id of the last source that set the current selection.
public  TransactionManagergetTransactionManager()
     Returns a transaction manager of the document.
public  booleansetPreferredComponentID(long preferredComponentID)
     Sets a preferred component ID.

Warning: This method is for deserialization purpose only (IO module).

public  voidsetRootComponent(DesignComponent rootComponent)
     Sets a root component of the document.
public  voidsetSelectedComponents(String selectionSourceID, Collection<DesignComponent> components)
     Sets selected components.


Constructor Detail
DesignDocument
public DesignDocument(DocumentInterface documentInterface)(Code)
Creates an instance of document.
Parameters:
  documentInterface - the documentInterface interface




Method Detail
createComponent
public DesignComponent createComponent(TypeID componentType)(Code)
Creates a new component using a component descriptor with specified typeid.

Note: It does not add the component into a tree, you have to do it manually.
Parameters:
  componentType - the component typeid the new component




createRawComponent
public DesignComponent createRawComponent(TypeID componentType)(Code)
Creates a new raw component using a component descriptor with specified typeid.

Note: It does not add the component into a tree, you have to do it manually.

Note: it just allocates the component, it does not do any post-initializion.
Parameters:
  componentType - the component typeid the new raw component




deleteComponent
public void deleteComponent(DesignComponent component)(Code)
Removes a component from the component tree and removes references to this component from all property values in all components in the document.

Note: It does not allows to remove the root component.
Parameters:
  component - the component




deleteComponents
public void deleteComponents(Collection<DesignComponent> components)(Code)
Removes components from the component tree and removes references to these components from all property values in all components in the document.

Note: It does not allows to remove the root component.
Parameters:
  components - the components




getComponentByUID
public DesignComponent getComponentByUID(long componentID)(Code)
Returns a component with specified component id.
Parameters:
  componentID - the component id the component



getDescriptorRegistry
public DescriptorRegistry getDescriptorRegistry()(Code)
Returns a component descriptor registry related to the project when the document is placed. the descriptor registry



getDocumentInterface
public DocumentInterface getDocumentInterface()(Code)
Returns document interface of the document. the document interface



getListenerManager
public ListenerManager getListenerManager()(Code)
Returns a listener manager of the document. the listener manager



getRootComponent
public DesignComponent getRootComponent()(Code)
Returns a root component of components tree assigned to the document. the root component.



getSelectedComponents
public Collection<DesignComponent> getSelectedComponents()(Code)
Returns a set of selected components. the set of selected components.



getSelectionSourceID
public String getSelectionSourceID()(Code)
Returns an id of the last source that set the current selection. the source id



getTransactionManager
public TransactionManager getTransactionManager()(Code)
Returns a transaction manager of the document. the transaction manager



setPreferredComponentID
public boolean setPreferredComponentID(long preferredComponentID)(Code)
Sets a preferred component ID.

Warning: This method is for deserialization purpose only (IO module). Do not use it directly.
Parameters:
  preferredComponentID - the preferred component id true if preferred component id was used




setRootComponent
public void setRootComponent(DesignComponent rootComponent)(Code)
Sets a root component of the document. This method could be called only once.

Warning: This method should be used by IO module (where the document is created) only.
Parameters:
  rootComponent - the root component




setSelectedComponents
public void setSelectedComponents(String selectionSourceID, Collection<DesignComponent> components)(Code)
Sets selected components. It requires to specify a source id for identifying the source of the selection.

Note: Undo/redo of setSelectedComponents changed will use null as a selectionSourceID
Parameters:
  selectionSourceID - the source id
Parameters:
  components - the set of selected components.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.