com.izforge.izpack.api.event

Interface ProgressListener

public interface ProgressListener

This interface is used 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).

Method Summary

Modifier and Type	Method and Description
void	nextStep(String stepName, int step, int subSteps) Invoked when an action step starts.
void	progress(int subStep, String message) Invoked to notify progress.
void	progress(String message) Invoked to notify progress.
void	restartAction(String name, String overallMessage, String tip, int steps) Invoked when an action restarts.
void	setSubStepNo(int subSteps) Sets the number of sub-steps.
void	startAction(String name, int steps) Invoked when an action starts.
void	stopAction() Invoked when an action finishes.

Method Detail

startAction

void startAction(String name,
                 int steps)

Invoked when an action starts.

Parameters:

name - the name of the action

steps - the number of steps the action consists of

stopAction

void stopAction()

Invoked when an action finishes.

nextStep

void nextStep(String stepName,
              int step,
              int subSteps)

Invoked when an action step starts.

Parameters:

stepName - the name of the step

step - the step number

subSteps - the number of sub-steps the step consists of

setSubStepNo

void setSubStepNo(int subSteps)

Sets the number of sub-steps.

This may be used if the number of sub-steps changes during an action.

Parameters:

subSteps - the number of sub-steps

progress

void progress(String message)

Invoked to notify progress.

This increments the current step.

Parameters:

message - a message describing the step

progress

void progress(int subStep,
              String message)

Invoked to notify progress.

Parameters:

subStep - the sub-step which will be performed next

message - an additional message describing the sub-step

restartAction

void restartAction(String name,
                   String overallMessage,
                   String tip,
                   int steps)

Invoked when an action restarts.

Parameters:

name - the name of the action

overallMessage - a message describing the overall progress

tip - a tip describing the current progress

steps - the number of steps the action consists of