1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id$
29 */
30
31 package palmed.ui;
32
33 import javax.microedition.lcdui.Display;
34 import javax.microedition.lcdui.Displayable;
35 import javax.microedition.lcdui.Gauge;
36
37 /***
38 * This dialog displays a progress bar.
39 *
40 * @author Mathieu Champlon
41 * @version $Revision$ $Date$
42 */
43 public final class ProgressDialog extends Dialog implements IProgressIndicator
44 {
45 /***
46 * The display.
47 */
48 private final Display display_;
49 /***
50 * The displayable to show when closing the dialog.
51 */
52 private final Displayable next_;
53 /***
54 * The progress bar.
55 */
56 private final Gauge gauge_;
57
58 /***
59 * Create a progress dialog.
60 *
61 * @param display the application display
62 * @param operation the name of the operation under process
63 * @param steps the maximum number of steps
64 * @param next the displayable to show when 'OK' is pressed
65 */
66 public ProgressDialog( final Display display, final String operation, final int steps, final Displayable next )
67 {
68 super( "Please wait" );
69 if( display == null )
70 throw new IllegalArgumentException( "parameter 'display' is null" );
71 if( next == null )
72 throw new IllegalArgumentException( "parameter 'next' is null" );
73 gauge_ = new Gauge( operation, false, steps, 0 );
74 display_ = display;
75 next_ = next;
76 }
77
78 /***
79 * {@inheritDoc}
80 * <p>
81 * The dialog is dismissed if the maximum number of steps has been reached.
82 */
83 public void step()
84 {
85 gauge_.setValue( Gauge.INCREMENTAL_UPDATING );
86 if( gauge_.getValue() == gauge_.getMaxValue() )
87 display_.setCurrent( next_ );
88 }
89 }