View Javadoc

1   /*
2    * $Id: IDelayedDocumentEventListener.java,v 1.4 2004/09/20 03:51:39 jlerner Exp $
3    *
4    * Copyright (c) 1999-2004, BBN Technologies, LLC.
5    * All rights reserved.
6    * http://www.daml.org/legal/opensource/bbn_license.html
7    */
8    
9   package com.bbn.swede.editor;
10  
11  import org.eclipse.jface.text.DocumentEvent;
12  
13  /***
14   * A listener that handles composite document events in the OWL source editor.
15   * Document events are aggregated by the OWLDelayedSyntaxChecker until either a 
16   * certain amount of time passes without another event coming in or an event 
17   * comes in that is not adjacent to the one already being compiled.  At that 
18   * point, the composite event is sent out to all registered implementers of 
19   * IDelayedDocumentEventListener for handling.
20   * @see com.bbn.swede.editor.OWLDelayedSyntaxChecker#addDelayedDocumentEventListener(IDelayedDocumentEventListener)
21   * @author jlerner
22   */
23  public interface IDelayedDocumentEventListener
24  {
25     /***
26      * Performs custom handling of a composite document event.  Composite events
27      * are built and distributed by the OWL delayed syntax checker.
28      * @param e The composite event to be handled.  As with regular document
29      *          events, it may be a deletion, an insertion, or a combination of 
30      *          the two.
31      */
32     void handleEvent(DocumentEvent e);
33  }