/plugins/ProjectViewer/tags/pv_2_0_2/projectviewer/vpt/package.html

# · HTML · 37 lines · 28 code · 9 blank · 0 comment · 0 complexity · b9d33dc3612ea202b5d8abd14c51675f MD5 · raw file 

    

  1. <body><h3>Creating custom nodes.</h3>
    2. 

  2. 

  3. <p>It's possible to create new kinds of nodes to be inserted into a project.
    4. 

  4. Although not tested, all the necessary functionality is available. To create
    5. 

  5. a new kind of node, the following steps need to be taken:</p>
    6. 

  6. 

  7. <ul>
    8. 

  8. 

  9. <li>Create a new class that extends {@link projectviewer.vpt.VPTNode VPTNode}.
    10. 

  10. It's highly recommended that the NodeType for your node is not one of the four
    11. 

  11. constants defined in this class.</li>
    12. 

  12. 

  13. <li>Create a {@link projectviewer.persist.NodeHandler NodeHandler} to handle
    14. 

  14. loading and saving of your node type. Don't forget to register the node handler
    15. 

  15. in the <code>start()</code> method of your EditPlugin implementation.</li>
    16. 

  16. 

  17. <li>Create an {@link projectviewer.action.Action Action} that provides a way to
    18. 

  18. import new nodes into a project. Optionally, you may use the code available in
    19. 

  19. {@link projectviewer.importer.Importer Importer} to ease the importing of new
    20. 

  20. nodes.</li>
    21. 

  21. 

  22. </ul>
    23. 

  23. 

  24. <p>These steps should be enough to create a new kind of node and make it be
    25. 

  25. automatically persisted by the ProjectViewer plugin with the corresponding
    26. 

  26. project. You may want to provide other actions to be executed on the given
    27. 

  27. node (by creating more Action subclasses), or implement the
    28. 

  28. {@link projectviewer.vpt.VPTNode#open() open()} method of the node to specify
    29. 

  29. an action to be executed when the node receives a double click on the tree.
    30. 

  30. When implementing <code>open()</code>, make sure to make the <code>close()</code>,
    31. 

  31. <code>canOpen()</code> and <code>isOpened()</code> methods consistent with
    32. 

  32. your implementation.</p>
    33. 

  33. 

  34. <p>Implementing new nodes should be considered highly experimental, so bear
    35. 

  35. that in mind when going through this path.</p>
    36. 

  36. 

  37. </body>
    38.