ProgressUpdater

All Known Implementing Classes:: AbstractProgressUpdater, InterfaceProgressBar

public interface ProgressUpdater

Interface specifying methods to enable progress updates. Allows specifies a method (isCancelled for checking whether user has cancelled a procedure.

Since:: 1.0
Version:: 1.0
Author:: Andrew Reid

Nested Class Summary

Nested Classes

Modifier and Type Interface Description

static class ProgressUpdater.Mode

Method Summary

Modifier and Type	Method	Description
`boolean`	`allowChanges()`	Allow processes to change the settings of this progress bar? Implementing classes can choose whether or not to enforce this.
`void`	`cancel()`	Cancels execution of the process monitored by this updater.
`void`	`deregister()`	Deregisters this progress updater with the ModelGUI session
`int`	`getMaximum()`
`int`	`getMinimum()`
`boolean`	`isCancelled()`	Indicates whether the monitored process has been cancelled
`void`	`iterate()`	Increment progress by 1
`void`	`register()`	Registers this progress updater with the ModelGUI session
`void`	`reset()`
`void`	`setIndeterminate(boolean b)`	Sets whether this progress updater should be considered indeterminate; i.e., progress cannot be estimated.
`void`	`setMaximum(int max)`
`void`	`setMessage(java.lang.String message)`	Sets the message for this progress updater
`void`	`setMinimum(int min)`
`void`	`setMode(ProgressUpdater.Mode mode)`
`void`	`update(int t)`	Uodates the value of this progress indicator

Method Details
- iterate
  
  void iterate()
  
  Increment progress by 1
- update
  
  void update(int t)
  
  Uodates the value of this progress indicator
  
  Parameters:
  
  t -
- setMinimum
  
  void setMinimum(int min)
- setMaximum
  
  void setMaximum(int max)
- getMinimum
  
  int getMinimum()
- getMaximum
  
  int getMaximum()
- cancel
  
  void cancel()
  
  Cancels execution of the process monitored by this updater. The process must respect the cancel notification for this call to have effect.
- isCancelled
  
  boolean isCancelled()
  
  Indicates whether the monitored process has been cancelled
  
  Returns:
- setMode
  
  void setMode(ProgressUpdater.Mode mode)
- reset
  
  void reset()
- register
  
  void register()
  
  Registers this progress updater with the ModelGUI session
- deregister
  
  void deregister()
  
  Deregisters this progress updater with the ModelGUI session
- setMessage
  
  void setMessage(java.lang.String message)
  
  Sets the message for this progress updater
  
  Parameters:
  
  message -
- setIndeterminate
  
  void setIndeterminate(boolean b)
  
  Sets whether this progress updater should be considered indeterminate; i.e., progress cannot be estimated.
  
  Parameters:
  
  b -
- allowChanges
  
  boolean allowChanges()
  
  Allow processes to change the settings of this progress bar? Implementing classes can choose whether or not to enforce this.
  
  Returns: