ProgressWindow( min, max );
int min |
Minimum value of the progress bar. |
int max |
Maximum value of the progress bar. Can be reset
at anytime using the setNewMax() method. |
ProgressWindow Object
METHOD |
DESCRIPTION |
void setNewMax( int max ) |
Sets the new maximum value for the progress bar. |
void setReadoutValue( int value ) |
Sets the current value of the progress bar. |
void setElapsedTime( int time ) |
(optional) Sets the elapsed exposure time in seconds
if the window is used for camera readout progress.
|
void showElapsedTime( boolean show ) |
Set to true to use the window for camera readout progress.
This will allow the elapsed exposure time to be shown on the
window. False to disable this feature. Set to true by default.
|
void setCustomLabel( String text, boolean showsValue ) |
Allows one to set a custom label for the elapsed exposure
time label. The label text is set by the text parameter. The
showsValue parameter is true if the custom label can set an
integer value; false to only show the custom text label with no
associated value. |
void setCustomTitle( String text ) |
Allows one to set a custom title for the window. |
void setIcon( File file ) |
Allows one to set a custom icon for the window. |
void show() |
Displays the progress window. |
void close() |
Exits/closes the progress window. |
void test() |
Runs the progress window with test data for a
demo. |
Displays a progress window that can be used from scripts.
For example, can be used to show exposure elapsed time
and pixel readout. Can be used to represent the progress
of other tasks from within scripts as well.
Example: Create an expose/readout progress window ...
p = ProgressWindow( 0, 200 );
p.show();
... do exposure code here ...
p.setElapsedTime( elapsedTimeValue );
... do readout code here ...
p.setReadoutValue( pixelCount );
p.close();
Example: Create a custom progress window ...
p = ProgressWindow( 0, 200 );
p.showElapsedTime( false );
p.setCustomLabel( "My Task", false );
p.setCustomTitle( "My Window" );
p.show();
... do some task here and call setReadoutValue ...
p.setReadoutValue( someValue );
p.close();