View Javadoc

1   /*
2    * TouchGraph LLC. Apache-Style Software License
3    *
4    *
5    * Copyright (c) 2001-2002 Alexander Shapiro. All rights reserved.
6    *
7    * Redistribution and use in source and binary forms, with or without
8    * modification, are permitted provided that the following conditions
9    * are met:
10   *
11   * 1. Redistributions of source code must retain the above copyright
12   *    notice, this list of conditions and the following disclaimer. 
13   *
14   * 2. Redistributions in binary form must reproduce the above copyright
15   *    notice, this list of conditions and the following disclaimer in
16   *    the documentation and/or other materials provided with the
17   *    distribution.
18   *
19   * 3. The end-user documentation included with the redistribution,
20   *    if any, must include the following acknowledgment:  
21   *       "This product includes software developed by 
22   *        TouchGraph LLC (http://www.touchgraph.com/)."
23   *    Alternately, this acknowledgment may appear in the software itself,
24   *    if and wherever such third-party acknowledgments normally appear.
25   *
26   * 4. The names "TouchGraph" or "TouchGraph LLC" must not be used to endorse 
27   *    or promote products derived from this software without prior written 
28   *    permission.  For written permission, please contact 
29   *    alex@touchgraph.com
30   *
31   * 5. Products derived from this software may not be called "TouchGraph",
32   *    nor may "TouchGraph" appear in their name, without prior written
33   *    permission of alex@touchgraph.com.
34   *
35   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38   * DISCLAIMED.  IN NO EVENT SHALL TOUCHGRAPH OR ITS CONTRIBUTORS BE 
39   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
40   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
41   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
42   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
43   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
44   * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
45   * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46   * ====================================================================
47   *
48   */
49  
50  package com.touchgraph.graphlayout.interaction;
51  
52  import java.awt.event.*;
53  
54  import com.touchgraph.graphlayout.TGPanel;
55  
56  /*** TGAbstractClickUI allows one to write interfaces that deal with
57    * mouse clicks.
58    *   
59    * @author   Alexander Shapiro                                        
60    * @version  1.21  $Id: TGAbstractClickUI.java,v 1.1.1.1 2004/02/06 08:44:07 keesj Exp $
61    */
62  public abstract class TGAbstractClickUI extends TGSelfDeactivatingUI {
63  
64       private ACUIMouseListener ml;
65       private TGPanel tgPanel;
66       
67       public TGAbstractClickUI() { // Instantiate this way if you want to finish after one click
68           tgPanel=null;
69           ml= null;
70       }
71       
72       public TGAbstractClickUI(TGPanel tgp) { // Instantiate this way to keep listening for clicks until
73                                               // deactivate is called
74            tgPanel=tgp;
75            ml = new ACUIMouseListener();
76        }
77  
78       public final void activate() {
79           if (tgPanel!=null && ml!=null) tgPanel.addMouseListener(ml);
80       }
81           
82      public final void activate(MouseEvent e) {
83          mouseClicked(e);
84      }
85          
86      public final void deactivate() { 
87          if (tgPanel!=null && ml!=null) tgPanel.removeMouseListener(ml);
88          super.deactivate(); //To activate parentUI from TGUserInterface
89      }
90      
91      public abstract void mouseClicked(MouseEvent e);
92      
93      private class ACUIMouseListener extends MouseAdapter {    
94          public void mouseClicked(MouseEvent e) {
95              TGAbstractClickUI.this.mouseClicked(e);
96              if (selfDeactivate) deactivate();
97          }
98      }
99  
100 } // end com.touchgraph.graphlayout.interaction.TGAbstractClickUI