JavaGantt 2011.1 API

eu.beesoft.gaia.launcher
Interface ProgressMediator

All Known Implementing Classes:
ConsoleOutput, SplashScreen

public interface ProgressMediator

This interface describes a behavior of the UI component, which displays a progress of some long-term operation.


Method Summary
 void close()
          Closes a progress mediator instance.
 int getProgressRange()
          Returns maximum progress value.
 int getProgressStep()
          Returns a current progress step.
 java.lang.String getProgressText()
          Returns the currently displayed progress text.
 boolean isInterrupted()
          Returns true is user (in UI) interrupted operation for which is this progress monitor running.
 void setProgressRange(int max)
          Sets maximum progress value.
 void setProgressStep(int step)
          Sets the current progress step.
 void setProgressText(java.lang.String text)
          Sets the progress text to dislay.
 

Method Detail

getProgressRange

int getProgressRange()
Returns maximum progress value. A progress mediator has a range for its presentation from 0 to returned value.

Returns:
maximum progress value

setProgressRange

void setProgressRange(int max)
Sets maximum progress value. A progress mediator has a range for its presentation from 0 to returned value.

Parameters:
max - - maximum progress value

getProgressStep

int getProgressStep()
Returns a current progress step. The progress step is a value set by method setProgressStep(int) and is from interval [0, getProgressRange()].

Returns:
current progress step

setProgressStep

void setProgressStep(int step)
Sets the current progress step. The progress step is a value set by method setProgressStep(int) and is from interval [0, getProgressRange()].

Parameters:
step - - a progress step to set

getProgressText

java.lang.String getProgressText()
Returns the currently displayed progress text.

Returns:
progress text

setProgressText

void setProgressText(java.lang.String text)
Sets the progress text to dislay.

Parameters:
text - - a text to set

isInterrupted

boolean isInterrupted()
Returns true is user (in UI) interrupted operation for which is this progress monitor running.

Returns:
true if operation is interrupted by user

close

void close()
Closes a progress mediator instance. In implementation closes dialog window etc.


JavaGantt 2011.1 API