root / import / ext3D / trunk / install-extension3d / IzPack / src / lib / com / izforge / izpack / util / AbstractUIProgressHandler.java @ 15280
History | View | Annotate | Download (2.46 KB)
| 1 |
/*
|
|---|---|
| 2 |
* $Id: AbstractUIProgressHandler.java,v 1.1 2006/06/14 07:29:07 cesar Exp $
|
| 3 |
* IzPack
|
| 4 |
*
|
| 5 |
* Copyright (C) 2001-2003 Tino Schwarze, Julien Ponge
|
| 6 |
*
|
| 7 |
* File : AbstractUIProgress.java
|
| 8 |
* Description : An interface for user interaction and progress notification.
|
| 9 |
* Author's email : tino.schwarze@informatik.tu-chemnitz.de
|
| 10 |
* Author's Website : http://www.tisc.de
|
| 11 |
*
|
| 12 |
* This program is free software; you can redistribute it and/or
|
| 13 |
* modify it under the terms of the GNU General Public License
|
| 14 |
* as published by the Free Software Foundation; either version 2
|
| 15 |
* of the License, or any later version.
|
| 16 |
*
|
| 17 |
* This program is distributed in the hope that it will be useful,
|
| 18 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 19 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 20 |
* GNU General Public License for more details.
|
| 21 |
*
|
| 22 |
* You should have received a copy of the GNU General Public License
|
| 23 |
* along with this program; if not, write to the Free Software
|
| 24 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
| 25 |
*/
|
| 26 |
|
| 27 |
package com.izforge.izpack.util; |
| 28 |
|
| 29 |
/**
|
| 30 |
* This interface is used by functions which need to notify the user of some progress.
|
| 31 |
*
|
| 32 |
* For example, the installation progress and compilation progress are communicated to
|
| 33 |
* the user using this interface. The interface supports a two-stage progress indication:
|
| 34 |
* The whole action is divided into steps (for example, packs when installing) and
|
| 35 |
* sub-steps (for example, files of a pack).
|
| 36 |
*/
|
| 37 |
public interface AbstractUIProgressHandler extends AbstractUIHandler |
| 38 |
{
|
| 39 |
/**
|
| 40 |
* The action starts.
|
| 41 |
*
|
| 42 |
* @param name The name of the action.
|
| 43 |
* @param no_of_steps The number of steps the action consists of.
|
| 44 |
*/
|
| 45 |
public void startAction (String name, int no_of_steps); |
| 46 |
|
| 47 |
/**
|
| 48 |
* The action was finished.
|
| 49 |
*/
|
| 50 |
public void stopAction (); |
| 51 |
|
| 52 |
/**
|
| 53 |
* The next step starts.
|
| 54 |
*
|
| 55 |
* @param step_name The name of the step which starts now.
|
| 56 |
* @param step_no The number of the step.
|
| 57 |
* @param no_of_substeps The number of sub-steps this step consists of.
|
| 58 |
*/
|
| 59 |
public void nextStep (String step_name, int step_no, int no_of_substeps); |
| 60 |
|
| 61 |
/**
|
| 62 |
* Notify of progress.
|
| 63 |
*
|
| 64 |
* @param substep_no The substep which will be performed next.
|
| 65 |
* @param message An additional message describing the substep.
|
| 66 |
*/
|
| 67 |
public void progress (int substep_no, String message); |
| 68 |
|
| 69 |
} |