Package se.conciliate.extensions.ui

Class Shell.SimpleStatusProgress

java.lang.Object

se.conciliate.extensions.ui.Shell.SimpleStatusProgress

All Implemented Interfaces:

ProgressCallback, Shell.StatusProgress

Enclosing interface:

Shell

public static class Shell.SimpleStatusProgress
extends Object
implements Shell.StatusProgress, ProgressCallback

Simple status progress with a static title that consumes progress values between 0-100 where -1 is indeterminate.

Constructor Summary

Constructors

Constructor	Description
SimpleStatusProgress(boolean abortable)

Method Summary

Modifier and Type	Method	Description
void	abort()
void	aborted()	The process has been aborted.
void	addPropertyChangeListener(PropertyChangeListener l)
void	finished()	All steps have finished.
int	getProgress()
String	getText()
boolean	isAbortable()
boolean	isComplete()
boolean	isUserAborting()	Returns true if the user has requested abortion.
void	removePropertyChangeListener(PropertyChangeListener l)
void	setComplete()
void	setProgress(int progress)
void	setText(String text)
void	startStep(int step, String description, boolean indeterminate)	A new step has begun.
void	stepDescription(String description)	Updates the description text for the current step.
void	stepProgress(int percent)	Progress has been made in the current step.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface se.conciliate.extensions.ui.ProgressCallback

exception, isGUI, log, logWarning, startProgress

Methods inherited from interface se.conciliate.extensions.ui.Shell.StatusProgress

getOnClickAction

Constructor Details

SimpleStatusProgress

public SimpleStatusProgress(boolean abortable)

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Shell.StatusProgress

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Shell.StatusProgress

getText

public String getText()

Specified by:

getText in interface Shell.StatusProgress

getProgress

public int getProgress()

Specified by:

getProgress in interface Shell.StatusProgress

isComplete

public boolean isComplete()

Specified by:

isComplete in interface Shell.StatusProgress

startStep

public void startStep(int step,
 String description,
 boolean indeterminate)

Description copied from interface: ProgressCallback

A new step has begun.

Specified by:

startStep in interface ProgressCallback

Parameters:

step - index of the step

description - A description of the current step

indeterminate - true if the step is indeterminate (won't call stepProgress(int)

stepProgress

public void stepProgress(int percent)

Description copied from interface: ProgressCallback

Progress has been made in the current step.

Specified by:

stepProgress in interface ProgressCallback

Parameters:

percent - how much of the current step that is completed

stepDescription

public void stepDescription(String description)

Description copied from interface: ProgressCallback

Updates the description text for the current step.

Specified by:

stepDescription in interface ProgressCallback

finished

public void finished()

Description copied from interface: ProgressCallback

All steps have finished.

Specified by:

finished in interface ProgressCallback

aborted

public void aborted()

Description copied from interface: ProgressCallback

The process has been aborted. This method is expected to be called if isUserAborting() is returning true or after exception(Exception) has been called.

Specified by:

aborted in interface ProgressCallback

isAbortable

public boolean isAbortable()

Specified by:

isAbortable in interface Shell.StatusProgress

abort

public void abort()

Specified by:

abort in interface Shell.StatusProgress

isUserAborting

public boolean isUserAborting()

Description copied from interface: ProgressCallback

Returns true if the user has requested abortion.

Specified by:

isUserAborting in interface ProgressCallback

Returns:

true if the publishing should stop

setComplete

public void setComplete()

setText

public void setText(String text)

setProgress

public void setProgress(int progress)