HiRISE

HiRISE.HiCat.Utilities
Class Progress_Utility

java.lang.Object
  extended by HiRISE.HiCat.Utilities.Progress_Utility

public class Progress_Utility
extends Object

A utility class for creating Progress_Monitor dialogs.

This class is based on GPL code written by Santhosh Kumar T. The original code can be found at http://jroller.com/santhosh/entry/show_progress_in_modal_dialog.

Author:
Rodney Heyd UA/PIRL

Field Summary
static String ID
          Class Identifier
 
Constructor Summary
Progress_Utility()
           
 
Method Summary
static Progress_Monitor createModalProgressMonitor(Component owner, int total, boolean indeterminate, int milliSecondsToWait, String name)
          Creates a modal progress dialog and returns the Progress_Monitor that is the data model for the monitor dialog.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class Identifier

See Also:
Constant Field Values
Constructor Detail

Progress_Utility

public Progress_Utility()
Method Detail

createModalProgressMonitor

public static Progress_Monitor createModalProgressMonitor(Component owner,
                                                          int total,
                                                          boolean indeterminate,
                                                          int milliSecondsToWait,
                                                          String name)
Creates a modal progress dialog and returns the Progress_Monitor that is the data model for the monitor dialog. If the the owner of the dialog is null (or invisible), then the progress dialog will be non-modal.

Parameters:
owner - The component the progress dialog should block
total - the total amount of progress to be made - used to set the maximum scale of the progress bar
indeterminate - set to true if the amount of progress is indeterminate
milliSecondsToWait - number of millseconds to wait before displaying the progress monitor
name - a string to identify the Progress_Monitor
Returns:
a Progress_Monitor
See Also:
Progress_Monitor, Progress_Dialog

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona