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

# · HTML · 51 lines · 39 code · 12 blank · 0 comment · 0 complexity · 32b3232d6a67ada8dfcd7380583e8e2c MD5 · raw file 

    

  1. <body>Working with the Project Viewer.
    2. 

  2. 

  3. <p>External plugins can interact with the Project Viewer plugin in various
    4. 

  4. ways:</p>
    5. 

  5. 

  6. <ul>
    7. 

  7. 	<li>By providing project specific properties: {@linkplain projectviewer.config properties}</li>
    8. 

  8. 

  9. 	<li>By creating new node types: {@linkplain projectviewer.vpt nodes}</li>
    10. 

  10. 

  11. 	<li>By creating node-specific actions: {@linkplain projectviewer.action actions} </li>
    12. 

  12. 

  13. 	<li>By listening to Project Viewer events</li>
    14. 

  14. </ul>
    15. 

  15. 

  16. <p>In this document, we explain how to use Project Viewer events to track user
    17. 

  17. actions on the Project Viewer's interface.</p>
    18. 

    19. 

  19. <p>The Project Viewer plugin provides a different interface for each open jEdit
    20. 

  20. view, so the user can work with different projects in different views. This is
    21. 

  21. useful for PV's purposes, but some plugins may not benefit from such a dependence.</p>
    22. 

    23. 

  23. <p>For this reason, the event notification provided by PV can be used by either
    24. 

  24. kind of plugins. The
    25. 

  25. {@link projectviewer.ProjectViewer#addProjectViewerListener(ProjectViewerListener,View)
    26. 

  26. 	addProjectViewerListener()} in class
    27. 

  27. {@link projectviewer.ProjectViewer ProjectViewer} provides a way for both types of
    28. 

  28. plugin to register for PV events.</p>
    29. 

  29. 

  30. <p>Currently, the only event notification is for when a new project is loaded
    31. 

  31. into PV. This works differently for plugins that rely on jEdit's views and for
    32. 

  32. those that do not. For plugins that are view-dependent (which means, generally,
    33. 

  33. that there is an instance of some class for each open jEdit view, just like the
    34. 

  34. ProjectViewer class), these events are only fired when a project is loaded into
    35. 

  35. that particular instance of PV in that view. Changes in other views will not
    36. 

  36. fire any events for that listener.</p>
    37. 

  37. 

  38. <p>For plugins that do not take into account the current active view, events are
    39. 

  39. fired more oftenly. Any change of the current project in any view will fire an
    40. 

  40. event for these listeners. Also, when the current view is changed (i.e., the
    41. 

  41. user starts working on another view), an event is fired saying that the project
    42. 

  42. currently active in that view has been activated.</p>
    43. 

  43. 

  44. <p>These events can be very useful for plugins that want integration with some
    45. 

  45. aspect of a project. For example, a plugin may want to display information about
    46. 

  46. some build file for the project, so each time a project is changed the information
    47. 

  47. displayed changes. Or maybe the plugin can use different properties for different
    48. 

  48. projects. For more complex interaction with the ProjectViewer plugin, please
    49. 

  49. read the other documentation linked at the beginning of this document.</p>
    50. 

  50. 

  51. </body>
    52.