com.izforge.izpack.util

Interface AbstractUIProgressHandler

All Superinterfaces:

AbstractUIHandler

All Known Subinterfaces:

CompileHandler

All Known Implementing Classes:

CompilePanel, CompilePanelAutomationHelper, ExtendedInstallPanel, InstallPanel, InstallPanelAutomationHelper, UninstallerFrame.DestroyerHandler

public interface AbstractUIProgressHandler
extends AbstractUIHandler

This interface is used by functions which need to notify the user of some progress. For example, the installation progress and compilation progress are communicated to the user using this interface. The interface supports a two-stage progress indication: The whole action is divided into steps (for example, packs when installing) and sub-steps (for example, files of a pack).

Field Summary

Fields inherited from interface com.izforge.izpack.util.AbstractUIHandler

ANSWER_CANCEL, ANSWER_NO, ANSWER_YES, CHOICES_YES_NO, CHOICES_YES_NO_CANCEL

Method Summary

Methods

Modifier and Type	Method and Description
void	nextStep(java.lang.String step_name, int step_no, int no_of_substeps) The next step starts.
void	progress(int substep_no, java.lang.String message) Notify of progress.
void	startAction(java.lang.String name, int no_of_steps) The action starts.
void	stopAction() The action was finished.

Methods inherited from interface com.izforge.izpack.util.AbstractUIHandler

askQuestion, askQuestion, emitError, emitNotification, emitWarning

Method Detail

startAction

void startAction(java.lang.String name,
               int no_of_steps)

The action starts.

Parameters:

name - The name of the action.

no_of_steps - The number of steps the action consists of.

stopAction

void stopAction()

The action was finished.

nextStep

void nextStep(java.lang.String step_name,
            int step_no,
            int no_of_substeps)

The next step starts.

Parameters:

step_name - The name of the step which starts now.

step_no - The number of the step.

no_of_substeps - The number of sub-steps this step consists of.

progress

void progress(int substep_no,
            java.lang.String message)

Notify of progress.

Parameters:

substep_no - The substep which will be performed next.

message - An additional message describing the substep.