Venice 0.751beta

nz.org.venice.ui
Interface ProgressDialog

All Known Implementing Classes:
PrimaryProgressDialog, SecondaryProgressDialog

public interface ProgressDialog

This interface defines the functions that a progress dialog class should have. It's purpose is to allow us to create a PrimaryProgressDialog and a SecondaryProgressDialog where the secondary progress dialog proxies to the first.

See ProgressDialogManager for details about using progress dialogs in venice.


Method Summary
 void decrement()
          Decrement current progress by one unit.
 int getMaximum()
          Get the maximum progress value.
 int getMinimum()
          Get the minimum progress value.
 java.lang.String getNote()
          Get the note or rather the action we are curently waiting for.
 int getProgress()
          Get current progress value.
 void hide()
          Close the dialog window.
 void increment()
          Increment current progress by one unit.
 boolean isIndeterminate()
          Return whether the dialog is indeterminate.
 boolean isMaster()
          Query if the dialog is a master dialog.
 void setIndeterminate(boolean indeterminate)
          Set whether the dialog is indeterminate.
 void setMaster(boolean master)
          Set whether dialog is a master dialog.
 void setMaximum(int maximum)
          Get the maximum progress value.
 void setMinimum(int minimum)
          Set the minimum progress value.
 void setNote(java.lang.String note)
          Set the note or rather the action we are curently waiting for.
 void setProgress(int progress)
          Set current progress value.
 void show(java.lang.String title)
          Show the dialog window.
 

Method Detail

hide

public void hide()
Close the dialog window.


show

public void show(java.lang.String title)
Show the dialog window.

Parameters:
title - the title should be set to the task that we are performing, which is not necessarily the action we are waiting for. e.g. the task might be "Graph CBA", but the action we are waiting for would be "Load CBA Quotes".

getNote

public java.lang.String getNote()
Get the note or rather the action we are curently waiting for. E.g. the task might be "Graph CBA", but the action we are waiting for would be "Load CBA Quotes".

Returns:
the action we are waiting for

setNote

public void setNote(java.lang.String note)
Set the note or rather the action we are curently waiting for. E.g. the task might be "Graph CBA", but the action we are waiting for would be "Load CBA Quotes".

Parameters:
note - the action we are waiting for

getMinimum

public int getMinimum()
Get the minimum progress value.

Returns:
the minimum progress value

setMinimum

public void setMinimum(int minimum)
Set the minimum progress value.

Parameters:
minimum - the minimum progress value

getMaximum

public int getMaximum()
Get the maximum progress value.

Returns:
the maximum progress value

setMaximum

public void setMaximum(int maximum)
Get the maximum progress value.

Parameters:
maximum - the maximum progress value

getProgress

public int getProgress()
Get current progress value.

Returns:
Value of property progress

setProgress

public void setProgress(int progress)
Set current progress value.

Parameters:
progress - New value of property progress

increment

public void increment()
Increment current progress by one unit.


decrement

public void decrement()
Decrement current progress by one unit.


isIndeterminate

public boolean isIndeterminate()
Return whether the dialog is indeterminate. An indeterminate progress does not given the user any indication of when the task might be completed.

Returns:
true if no progress is displayed

setIndeterminate

public void setIndeterminate(boolean indeterminate)
Set whether the dialog is indeterminate. An indeterminate progress does not given the user any indication of when the task might be completed.

Parameters:
indeterminate - true if no progress can be displayed

setMaster

public void setMaster(boolean master)
Set whether dialog is a master dialog.

Parameters:
master - whether the dialog is a master dialog
See Also:
ProgressDialogManager

isMaster

public boolean isMaster()
Query if the dialog is a master dialog.

Returns:
whether the dialog is a master dialog
See Also:
ProgressDialogManager

Venice 0.751beta