View Javadoc

1   /*
2    * Copyright (c) 2003, Andreas Pataki 
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are
7    * met:
8    *
9    * Redistributions of source code must retain the above copyright notice,
10   * this list of conditions and the following disclaimer.
11   * 
12   * Redistributions in binary form must reproduce the above copyright notice,
13   * this list of conditions and the following disclaimer in the documentation
14   * and/or other materials provided with the distribution.
15   * 
16   * Neither the name of the author nor the names of its contributors
17   * may be used to endorse or promote products derived from this software
18   * without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS
21   * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22   * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   */
32  
33  package net.sf.tm.plugin.actions;
34  
35  import org.eclipse.swt.custom.BusyIndicator;
36  
37  /***
38   * Abstract base class for all actions which must provide a busy indicator
39   * during there run operation.
40   * 
41   * @author Andreas Pataki
42   * @version $Id: AbstractBusyAction.java,v 1.4 2004/02/10 20:11:25 apataki Exp $
43   */
44  public abstract class AbstractBusyAction extends AbstractAction {
45  
46      /***
47       * Don't overwrite the run method in the actual action implementation.
48       * The run method will do a call to the {@link #runWithBusyIndicator()} 
49       * method using a <code>BusyIndicator<code>.
50       * 
51       * @see org.eclipse.jface.action.Action#run()
52       */
53      public void run() {
54          BusyIndicator.showWhile(null, new Runnable() {
55  
56              public void run() {
57                  runWithBusyIndicator();
58              }
59  
60          });
61      }
62  
63      /***
64       * In the actual action implementation all stuff which should be excecuted
65       * with a busy indicator must be placed in this method.
66       */
67      protected abstract void runWithBusyIndicator();
68  
69  }