Java Doc for GlobalEventNotifier.java in  » IDE » DrJava » edu » rice » cs » drjava » 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 » DrJava » edu.rice.cs.drjava.model 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


edu.rice.cs.drjava.model.GlobalEventNotifier

GlobalEventNotifier
public class GlobalEventNotifier extends EventNotifier implements GlobalModelListener,Serializable(Code)
Keeps track of all listeners to the model, and has the ability to notify them of some event.

This class has a specific role of managing GlobalModelListeners. Other classes with similar names use similar code to perform the same function for other interfaces, e.g. InteractionsEventNotifier and JavadocEventNotifier. These classes implement the appropriate interface definition so that they can be used transparently as composite packaging for a particular listener interface.

Components which might otherwise manage their own list of listeners use EventNotifiers instead to simplify their internal implementation. Notifiers should therefore be considered a private implementation detail of the components, and should not be used directly outside of the "host" component.

TODO: remove direct references to GlobalEventNotifier outside of DefaultGlobalModel TODO: remove public modifier from this class when above has happened All methods in this class must use the synchronization methods provided by ReaderWriterLock. This ensures that multiple notifications (reads) can occur simultaneously, but only one thread can be adding or removing listeners (writing) at a time, and no reads can occur during a write.

No methods on this class should be synchronized using traditional Java synchronization!


version:
   $Id: GlobalEventNotifier.java 4255 2007-08-28 19:17:37Z mgricken $


Inner Class :abstract public static class Notifier
Inner Class :abstract public static class Poller



Method Summary
public  voidactiveDocumentChanged(OpenDefinitionsDocument active)
     Called when the selection in the navigator changes the active document.
public  voidactiveDocumentRefreshed(OpenDefinitionsDocument active)
     Called when the active document is refreshed.
public  booleancanAbandonFile(OpenDefinitionsDocument doc)
     Called to ask the listeners if it is OK to abandon the current document.
public  voidclassFileError(ClassFileError e)
     Called when trying to test an illegal class file.
public  voidcompileBeforeJUnit(CompilerListener cl)
     Called before attempting unit testing if tested class files are out of sync, to give the user a chance to save.
public  voidcompileEnded(File workDir, List<? extends File> excludedFiles)
     Called when a compile has finished running.
public  voidcompileStarted()
     Called after a compile is started by the GlobalModel.
public  voidconsoleReset()
     Called when the console window is reset.
public  voidcurrentDirectoryChanged(File dir)
     Called when the selection in the navigator changes the current directory without changing the active document.
public  voiddocumentNotFound(OpenDefinitionsDocument d, File f)
    
public  voidexecuteAsyncTask(AsyncTask<P, R> task, P param, boolean showProgress, boolean lockUI)
    
public  voidfileClosed(OpenDefinitionsDocument doc)
     Called after a document is closed.
public  voidfileOpened(OpenDefinitionsDocument doc)
     Called after a file is opened and read into the current document.
public  voidfilePathContainsPound()
     Notifies the view that the current file path contains a #.
public  voidfileReverted(OpenDefinitionsDocument doc)
     Called after a document is reverted.
public  voidfileSaved(OpenDefinitionsDocument doc)
     Called after the current document is saved.
public  voidfilesNotFound(File... f)
    
public  voidfocusOnDefinitionsPane()
     Called to shift the focus to the Definitions Pane.
public  voidfocusOnLastFocusOwner()
     Called to shift the focus to the last focus owner among the main frame panes.
public  voidhandleAlreadyOpenDocument(OpenDefinitionsDocument doc)
     Performs any UI related steps to handle the case in which a file is being opened that is already open and modified.
public  voidinteractionEnded()
     Called when an interaction has finished running.
public  voidinteractionErrorOccurred(int offset, int length)
     Called when the interactions window generates a syntax error.
public  voidinteractionIncomplete()
     Notifies the view that the current interaction is incomplete.
public  voidinteractionStarted()
     Called after an interaction is started by the GlobalModel.
public  voidinterpreterChanged(boolean inProgress)
     Called when the active interpreter is changed.
Parameters:
  inProgress - Whether the new interpreter is processing an interaction (i.e,.
public  voidinterpreterExited(int status)
     Called when the interactions JVM was closed by System.exit or by being aborted.
public  voidinterpreterReady(File wd)
     Called when the interactions window is reset.
public  voidinterpreterResetFailed(Throwable t)
     Called if the interpreter reset failed.
public  voidinterpreterResetting()
     Called when the interactionsJVM has begun resetting.
public  voidjavadocEnded(boolean success, File destDir, boolean allDocs)
     Called after Javadoc is finished.
public  voidjavadocStarted()
     Called after Javadoc is started by the GlobalModel.
public  voidjunitClassesStarted()
     Called when testing specific list of classes.
public  voidjunitEnded()
     Called after JUnit is finished running tests.
public  voidjunitStarted()
     Called after JUnit is started by the GlobalModel.
public  voidjunitSuiteStarted(int numTests)
     Called to indicate that a suite of tests has started running.
public  voidjunitTestEnded(String name, boolean wasSuccessful, boolean causedError)
     Called when a particular test has ended.
public  voidjunitTestStarted(String name)
     Called when a particular test is started.
public  voidnewFileCreated(OpenDefinitionsDocument doc)
     Called after a new document is created.
public  voidnonTestCase(boolean isTestAll)
     Called when trying to test a non-TestCase class.
public  voidnotifyListeners(Notifier n)
     Lets the listeners know some event has taken place.
public  booleanpollListeners(Poller p)
     Allows the GlobalModel to ask its listeners a yes/no question and receive a response.
public  voidprojectBuildDirChanged()
    
public  voidprojectClosed()
    
public  voidprojectModified()
    
public  voidprojectOpened(File pfile, FileOpenSelector files)
    
public  voidprojectRunnableChanged()
    
public  voidprojectWorkDirChanged()
    
public  booleanquitFile(OpenDefinitionsDocument doc)
     Called to ask the listeners save the file before quitting at the user's option.
public  voidrunStarted(OpenDefinitionsDocument doc)
     Called when a file's main method is about to be run.
public  voidsaveBeforeCompile()
     Called to demand that all files be saved before compiling.
public  voidsaveBeforeJavadoc()
     Called before attempting Javadoc, to give the user a chance to save.
public  voidsaveUntitled()
     Called to demand that the active document, which is untitled, is saved before compiling.
public  booleanshouldRevertFile(OpenDefinitionsDocument doc)
     Called to ask the listeners if it is OK to revert the current document to the version saved on disk.
public  voidslaveJVMUsed()
    
public  voidundoableEditHappened()
     Called when an undoable edit occurs.



Method Detail
activeDocumentChanged
public void activeDocumentChanged(OpenDefinitionsDocument active)(Code)
Called when the selection in the navigator changes the active document.



activeDocumentRefreshed
public void activeDocumentRefreshed(OpenDefinitionsDocument active)(Code)
Called when the active document is refreshed.



canAbandonFile
public boolean canAbandonFile(OpenDefinitionsDocument doc)(Code)
Called to ask the listeners if it is OK to abandon the current document.



classFileError
public void classFileError(ClassFileError e)(Code)
Called when trying to test an illegal class file.
Parameters:
  e - the ClassFileError thrown when DrJava attempted to load the offending file



compileBeforeJUnit
public void compileBeforeJUnit(CompilerListener cl)(Code)
Called before attempting unit testing if tested class files are out of sync, to give the user a chance to save. Do not continue with JUnit if the user doesn't recompile!



compileEnded
public void compileEnded(File workDir, List<? extends File> excludedFiles)(Code)
Called when a compile has finished running.



compileStarted
public void compileStarted()(Code)
Called after a compile is started by the GlobalModel.



consoleReset
public void consoleReset()(Code)
Called when the console window is reset.



currentDirectoryChanged
public void currentDirectoryChanged(File dir)(Code)
Called when the selection in the navigator changes the current directory without changing the active document.



documentNotFound
public void documentNotFound(OpenDefinitionsDocument d, File f)(Code)



executeAsyncTask
public void executeAsyncTask(AsyncTask<P, R> task, P param, boolean showProgress, boolean lockUI)(Code)



fileClosed
public void fileClosed(OpenDefinitionsDocument doc)(Code)
Called after a document is closed.



fileOpened
public void fileOpened(OpenDefinitionsDocument doc)(Code)
Called after a file is opened and read into the current document.



filePathContainsPound
public void filePathContainsPound()(Code)
Notifies the view that the current file path contains a #.



fileReverted
public void fileReverted(OpenDefinitionsDocument doc)(Code)
Called after a document is reverted.



fileSaved
public void fileSaved(OpenDefinitionsDocument doc)(Code)
Called after the current document is saved.



filesNotFound
public void filesNotFound(File... f)(Code)



focusOnDefinitionsPane
public void focusOnDefinitionsPane()(Code)
Called to shift the focus to the Definitions Pane.



focusOnLastFocusOwner
public void focusOnLastFocusOwner()(Code)
Called to shift the focus to the last focus owner among the main frame panes.



handleAlreadyOpenDocument
public void handleAlreadyOpenDocument(OpenDefinitionsDocument doc)(Code)
Performs any UI related steps to handle the case in which a file is being opened that is already open and modified. The two choices are to revert to the copy on disk, or to keep the current changes.
Parameters:
  doc - true if the user wishes to revert the document, false to ignore



interactionEnded
public void interactionEnded()(Code)
Called when an interaction has finished running.



interactionErrorOccurred
public void interactionErrorOccurred(int offset, int length)(Code)
Called when the interactions window generates a syntax error.
Parameters:
  offset - the error's offset into the InteractionsDocument.
Parameters:
  length - the length of the error.



interactionIncomplete
public void interactionIncomplete()(Code)
Notifies the view that the current interaction is incomplete.



interactionStarted
public void interactionStarted()(Code)
Called after an interaction is started by the GlobalModel.



interpreterChanged
public void interpreterChanged(boolean inProgress)(Code)
Called when the active interpreter is changed.
Parameters:
  inProgress - Whether the new interpreter is processing an interaction (i.e,. whether an interactionEndedevent will be fired)



interpreterExited
public void interpreterExited(int status)(Code)
Called when the interactions JVM was closed by System.exit or by being aborted. Immediately after this the interactions will be reset.
Parameters:
  status - the exit code



interpreterReady
public void interpreterReady(File wd)(Code)
Called when the interactions window is reset.



interpreterResetFailed
public void interpreterResetFailed(Throwable t)(Code)
Called if the interpreter reset failed.
Parameters:
  t - Throwable explaining why the reset failed.(Subclasses must maintain listeners.)



interpreterResetting
public void interpreterResetting()(Code)
Called when the interactionsJVM has begun resetting.



javadocEnded
public void javadocEnded(boolean success, File destDir, boolean allDocs)(Code)
Called after Javadoc is finished.
Parameters:
  success - whether the Javadoc operation generated proper output
Parameters:
  destDir - if (success) the location where the output was generated, otherwise undefined (possibly null)
Parameters:
  allDocs - Whether Javadoc was run for all open documents



javadocStarted
public void javadocStarted()(Code)
Called after Javadoc is started by the GlobalModel.



junitClassesStarted
public void junitClassesStarted()(Code)
Called when testing specific list of classes.



junitEnded
public void junitEnded()(Code)
Called after JUnit is finished running tests.



junitStarted
public void junitStarted()(Code)
Called after JUnit is started by the GlobalModel.



junitSuiteStarted
public void junitSuiteStarted(int numTests)(Code)
Called to indicate that a suite of tests has started running.
Parameters:
  numTests - The number of tests in the suite to be run.



junitTestEnded
public void junitTestEnded(String name, boolean wasSuccessful, boolean causedError)(Code)
Called when a particular test has ended.
Parameters:
  name - the name of the test that has ended
Parameters:
  wasSuccessful - whether the test passed or not
Parameters:
  causedError - if not successful, whether the test caused an error or simply failed



junitTestStarted
public void junitTestStarted(String name)(Code)
Called when a particular test is started.
Parameters:
  name - The name of the test being started.



newFileCreated
public void newFileCreated(OpenDefinitionsDocument doc)(Code)
Called after a new document is created.



nonTestCase
public void nonTestCase(boolean isTestAll)(Code)
Called when trying to test a non-TestCase class.
Parameters:
  isTestAll - whether or not it was a use of the test all button



notifyListeners
public void notifyListeners(Notifier n)(Code)
Lets the listeners know some event has taken place.
Parameters:
  n - tells the listener what happened.



pollListeners
public boolean pollListeners(Poller p)(Code)
Allows the GlobalModel to ask its listeners a yes/no question and receive a response.
Parameters:
  p - the question being asked of the listeners the listeners' responses ANDed together, true if they allagree, false if some disagree



projectBuildDirChanged
public void projectBuildDirChanged()(Code)



projectClosed
public void projectClosed()(Code)



projectModified
public void projectModified()(Code)



projectOpened
public void projectOpened(File pfile, FileOpenSelector files)(Code)



projectRunnableChanged
public void projectRunnableChanged()(Code)



projectWorkDirChanged
public void projectWorkDirChanged()(Code)



quitFile
public boolean quitFile(OpenDefinitionsDocument doc)(Code)
Called to ask the listeners save the file before quitting at the user's option. true if quitting should continue, false if the user cancelled



runStarted
public void runStarted(OpenDefinitionsDocument doc)(Code)
Called when a file's main method is about to be run.



saveBeforeCompile
public void saveBeforeCompile()(Code)
Called to demand that all files be saved before compiling. It is up to the caller of this method to check if the documents have been saved, using IGetDocuments.hasModifiedDocuments().



saveBeforeJavadoc
public void saveBeforeJavadoc()(Code)
Called before attempting Javadoc, to give the user a chance to save. Do not continue with Javadoc if the user doesn't save!



saveUntitled
public void saveUntitled()(Code)
Called to demand that the active document, which is untitled, is saved before compiling.



shouldRevertFile
public boolean shouldRevertFile(OpenDefinitionsDocument doc)(Code)
Called to ask the listeners if it is OK to revert the current document to the version saved on disk.



slaveJVMUsed
public void slaveJVMUsed()(Code)



undoableEditHappened
public void undoableEditHappened()(Code)
Called when an undoable edit occurs.



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