ExtTreeWillExpandListener


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.swing.outline;
21  
22  import javax.swing.event.TreeExpansionEvent  ;
23  import javax.swing.event.TreeWillExpandListener  ;
24  import javax.swing.tree.ExpandVetoException  ;
25  
26  /** A trivial extension to TreeWillExpandListener, to allow listeners to be
27   * notified if another TreeWillExpandListener vetos a pending expansion.
28   * If a TreeExpansionListener added to an instance of TreePathSupport implements
29   * this interface, it will be notified by the TreePathSupport if some other
30   * listener vetos expanding a node.
31   * <p>
32   * This interface is primarily used to avoid memory leaks if a TreeWillExpandListener
33   * constructs some data structure (like a TableModelEvent that is a translation
34   * of a TreeExpansionEvent) for use when the expansion actually occurs, to notify
35   * it that the pending TableModelEvent will never be fired.  It is not of much
36   * interest to the rest of the world.
37   *
38   * @author  Tim Boudreau
39   */
40  public interface ExtTreeWillExpandListener extends TreeWillExpandListener   {
41      
42      public void treeExpansionVetoed (TreeExpansionEvent   event, 
43          ExpandVetoException   exception);
44      
45  }
46
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags