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.Point;
53  import java.awt.event.*;
54  
55  import com.touchgraph.graphlayout.TGPanel;
56  
57  /*** TGAbstractMousePausedUI allows one to handle MousePaused events.
58    *
59    * @author   Alexander Shapiro
60    * @version  1.21  $Id: TGAbstractMousePausedUI.java,v 1.1.1.1 2004/02/06 08:44:07 keesj Exp $
61    */
62  public abstract class TGAbstractMousePausedUI extends TGUserInterface {
63  
64       private AMPUIMouseMotionListener mml;
65       private AMPUIMouseListener ml;
66       protected TGPanel tgPanel;
67       Point mousePos=null;
68       PauseThread pauseThread=null;
69  
70    // ............
71  
72     /*** Constructor with TGPanel <tt>tgp</tt>.
73       */
74       public TGAbstractMousePausedUI( TGPanel tgp ) { // Instantiate this way to keep listening
75                                                       // for clicks until deactivate is called
76            tgPanel=tgp;
77            ml = new AMPUIMouseListener();
78            mml = new AMPUIMouseMotionListener();
79        }
80  
81       public final void activate() {
82          preActivate();
83            tgPanel.addMouseMotionListener(mml);
84            tgPanel.addMouseListener(ml);
85       }
86  
87      public final void deactivate() {
88          tgPanel.removeMouseMotionListener(mml);
89          tgPanel.removeMouseListener(ml);
90          postDeactivate();
91          super.deactivate(); //To activate parentUI from TGUserInterface
92      }
93  
94      public void preActivate() {}
95      public void postDeactivate() {}
96      public abstract void mousePaused(MouseEvent e);
97      public abstract void mouseMoved(MouseEvent e);
98      public abstract void mouseDragged(MouseEvent e);
99  
100     class PauseThread extends Thread{
101         boolean resetSleep;
102         boolean cancelled;
103            PauseThread() { cancelled = false; start(); }
104 
105            void reset() { resetSleep = true; cancelled = false; }
106            void cancel() { cancelled = true; }
107 
108            public void run() {
109                try {
110                    do {  resetSleep=false; sleep(250); } while (resetSleep);
111                 if (!cancelled) {
112                     MouseEvent pausedEvent =
113                         new MouseEvent(tgPanel,MouseEvent.MOUSE_ENTERED, 0,0, mousePos.x,mousePos.y,0,false);
114                     mousePaused(pausedEvent);
115                 }
116                }
117                catch (Exception e) {e.printStackTrace();}
118            }
119     }
120 
121     public void resetPause() {
122         if (pauseThread!=null && pauseThread.isAlive()) pauseThread.reset();
123         else pauseThread = new PauseThread();
124     }
125 
126     public void cancelPause() {
127         if (pauseThread!=null && pauseThread.isAlive()) pauseThread.cancel();
128     }
129 
130     private class AMPUIMouseMotionListener implements MouseMotionListener {
131         public void mouseMoved(MouseEvent e) {
132               mousePos=e.getPoint();
133               resetPause();
134               TGAbstractMousePausedUI.this.mouseMoved(e);
135         }
136 
137         public void mouseDragged(MouseEvent e) {
138               mousePos=e.getPoint();
139               resetPause();
140               TGAbstractMousePausedUI.this.mouseDragged(e);
141         }
142     }
143 
144     private class AMPUIMouseListener extends MouseAdapter {
145         public void mousePressed(MouseEvent e) {
146               cancelPause();
147         }
148         public void mouseReleased(MouseEvent e) {
149               cancelPause();
150         }
151         public void mouseExited(MouseEvent e) {
152               //cancelPause();
153         }
154     }
155 
156 } // end com.touchgraph.graphlayout.interaction.TGAbstractMousePauseUI