KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > izforge > izpack > util > ExtendedUIProgressHandler


1 /*
2  * IzPack - Copyright 2001-2007 Julien Ponge, All Rights Reserved.
3  *
4  * http://www.izforge.com/izpack/
5  * http://developer.berlios.de/projects/izpack/
6  *
7  * Copyright 2004 Klaus Bartz
8  *
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  */
21
22 package com.izforge.izpack.util;
23
24 /**
25  * This interface allowes an extended interaction with a user interface handler.
26  *
27  * @author Klaus Bartz
28  */
29 public interface ExtendedUIProgressHandler
30 {
31
32     static final int BEFORE = 0;
33
34     static final int AFTER = 1;
35
36     /**
37      * The action restarts.
38      *
39      * @param name The name of the action.
40      * @param overallMsg message to be used in the overall label.
41      * @param tipMsg message to be used in the tip label.
42      * @param no_of_steps The number of steps the action consists of.
43      */
44     void restartAction(String JavaDoc name, String JavaDoc overallMsg, String JavaDoc tipMsg, int no_of_steps);
45
46     /**
47      * Notify of progress with automatic counting.
48      *
49      * @param stepMessage an additional message describing the substep the type of the substep
50      */
51     public void progress(String JavaDoc stepMessage);
52
53 }
54
Popular Tags