Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.event
Class DocumentEventDispatcher

java.lang.Object
  extended by com.jivesoftware.community.event.DocumentEventDispatcher

public class DocumentEventDispatcher
extends Object

Dispatcher for DocumentEvents. Register DocumentListeners at runtime using the addListener(DocumentListener) method, or add a child Jive Property to the key "eventListeners.DocumentListener" to register a listener that will persist across restarts.

For example, to register the com.acme.CustomDocumentListener class as a persistent listener the following code could be used: // add persistent key to have the listener loaded and registered automatically at startup JiveGlobals.setJiveProperty("eventListeners.DocumentListener.customDocumentListener", "com.acme.CustomDocumentListener.class"); // now add it for this runtime instance DocumentEventDispatcher.addListener(new com.acme.CustomerDocumentListener());


Method Summary
 void addListener(DocumentListener listener)
           
static void destroy()
          Destroy dispatcher.
 void dispatchEvent(DocumentEvent event)
           
static DocumentEventDispatcher getInstance()
           
 void removeListener(DocumentListener listener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static DocumentEventDispatcher getInstance()

addListener

public void addListener(DocumentListener listener)

removeListener

public void removeListener(DocumentListener listener)

destroy

public static void destroy()
Destroy dispatcher. Intended to be used primarily during testing.


dispatchEvent

public void dispatchEvent(DocumentEvent event)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.