Package com.biglybt.ui.swt.progress
Interface IProgressReportConstants
-
- All Known Subinterfaces:
IProgressReporterListener
,IProgressReportingListener
- All Known Implementing Classes:
FileDownloadWindow
,MainStatusBar.ProgressListener
,ProgressReporter
,ProgressReporterPanel
,ProgressReporterWindow
,ProgressReporterWindow.AutoRemoveListener
,ProgressReportingManager
,ProgressReportMessage
,UpdateMonitor.updateStatusChanger
public interface IProgressReportConstants
These are all the constants used by the ProgressReporter and related classesThese constants are in this separate interface so that classes that need to reference these constants can simply implement this interface and reference them directly like REPORT_TYPE_CANCEL == [some test] instead of having to fully reference them like IProgressReportConstants.REPORT_TYPE_CANCEL == [some test]
-
-
Field Summary
Fields Modifier and Type Field Description static int
AUTO_CLOSE
Automatically closes the window when the reporter is finished; this only takes effect when there is only 1 reporter in the windowstatic int
BORDER
static int
MANAGER_EVENT_ADDED
When a reporter is added to the history liststatic int
MANAGER_EVENT_REMOVED
When a reporter is removed from the history liststatic int
MANAGER_EVENT_UPDATED
When a reporter that is already in the history list report an eventstatic int
MODAL
Open the window as MODALstatic int
MSG_TYPE_ERROR
static int
MSG_TYPE_INFO
static int
MSG_TYPE_LOG
static int
NONE
Default style bit for no stylesstatic int
REPORT_TYPE_CANCEL
WhenProgressReporter.cancel()
is detectedstatic int
REPORT_TYPE_DISPOSED
WhenProgressReporter.dispose()
is calledstatic int
REPORT_TYPE_DONE
WhenProgressReporter.setDone()
is detectedstatic int
REPORT_TYPE_ERROR
WhenProgressReporter.setErrorMessage(String)
is detectedstatic int
REPORT_TYPE_INIT
Default event type indicating no eventstatic int
REPORT_TYPE_MODE_CHANGE
WhenProgressReporter.setIndeterminate(boolean)
is detectedstatic int
REPORT_TYPE_PROPERTY_CHANGED
When any other property is modifiedstatic int
REPORT_TYPE_RETRY
WhenProgressReporter.retry()
is detectedstatic java.lang.String
REPORTER_TYPE_DEFAULT
Unless specified by the user for a particular reporter all reporters have this default typestatic int
REPORTER_VISIBILITY_SYSTEM
A hint to theProgressReportingManager
and any interested parties that the reporter and its reports are not intended to be shown (in full) to the user.static int
REPORTER_VISIBILITY_USER
The default visibility for aProgressReporter
; this is the most generous visibility level in that any interested processes can see this reporter and receive it'sProgressReporter.ProgressReport
This is used for when it makes sense to show the full information about a reporter to the user; this reporter will be seen in the progress historystatic int
RETVAL_OK
Default return value from a listener indicating the event has been received and processed successfullystatic int
RETVAL_OK_TO_DISPOSE
A return value from a listener indicating that the listener is done and is no longer interested in any subsequent event; this is a hint to the notifier so that the notifier can perform clean up operation relating to that particular listenerstatic int
SHOW_TOOLBAR
static int
STANDALONE
The reporter is the only one in a window
-
-
-
Field Detail
-
REPORTER_TYPE_DEFAULT
static final java.lang.String REPORTER_TYPE_DEFAULT
Unless specified by the user for a particular reporter all reporters have this default type- See Also:
- Constant Field Values
-
REPORTER_VISIBILITY_USER
static final int REPORTER_VISIBILITY_USER
The default visibility for aProgressReporter
; this is the most generous visibility level in that any interested processes can see this reporter and receive it'sProgressReporter.ProgressReport
This is used for when it makes sense to show the full information about a reporter to the user; this reporter will be seen in the progress history- See Also:
- Constant Field Values
-
REPORTER_VISIBILITY_SYSTEM
static final int REPORTER_VISIBILITY_SYSTEM
A hint to theProgressReportingManager
and any interested parties that the reporter and its reports are not intended to be shown (in full) to the user. UI components displaying progress reporters and reports can use this hint to show a minimum set of values and additionally skip soliciting the user for any loopback events.- See Also:
- Constant Field Values
-
REPORT_TYPE_INIT
static final int REPORT_TYPE_INIT
Default event type indicating no event- See Also:
- Constant Field Values
-
REPORT_TYPE_CANCEL
static final int REPORT_TYPE_CANCEL
WhenProgressReporter.cancel()
is detected- See Also:
- Constant Field Values
-
REPORT_TYPE_DONE
static final int REPORT_TYPE_DONE
WhenProgressReporter.setDone()
is detected- See Also:
- Constant Field Values
-
REPORT_TYPE_MODE_CHANGE
static final int REPORT_TYPE_MODE_CHANGE
WhenProgressReporter.setIndeterminate(boolean)
is detected- See Also:
- Constant Field Values
-
REPORT_TYPE_ERROR
static final int REPORT_TYPE_ERROR
WhenProgressReporter.setErrorMessage(String)
is detected- See Also:
- Constant Field Values
-
REPORT_TYPE_RETRY
static final int REPORT_TYPE_RETRY
WhenProgressReporter.retry()
is detected- See Also:
- Constant Field Values
-
REPORT_TYPE_PROPERTY_CHANGED
static final int REPORT_TYPE_PROPERTY_CHANGED
When any other property is modified- See Also:
- Constant Field Values
-
REPORT_TYPE_DISPOSED
static final int REPORT_TYPE_DISPOSED
WhenProgressReporter.dispose()
is called- See Also:
- Constant Field Values
-
RETVAL_OK
static final int RETVAL_OK
Default return value from a listener indicating the event has been received and processed successfully- See Also:
- Constant Field Values
-
RETVAL_OK_TO_DISPOSE
static final int RETVAL_OK_TO_DISPOSE
A return value from a listener indicating that the listener is done and is no longer interested in any subsequent event; this is a hint to the notifier so that the notifier can perform clean up operation relating to that particular listener- See Also:
- Constant Field Values
-
MANAGER_EVENT_ADDED
static final int MANAGER_EVENT_ADDED
When a reporter is added to the history list- See Also:
- Constant Field Values
-
MANAGER_EVENT_REMOVED
static final int MANAGER_EVENT_REMOVED
When a reporter is removed from the history list- See Also:
- Constant Field Values
-
MANAGER_EVENT_UPDATED
static final int MANAGER_EVENT_UPDATED
When a reporter that is already in the history list report an event- See Also:
- Constant Field Values
-
NONE
static final int NONE
Default style bit for no styles- See Also:
- Constant Field Values
-
AUTO_CLOSE
static final int AUTO_CLOSE
Automatically closes the window when the reporter is finished; this only takes effect when there is only 1 reporter in the window- See Also:
- Constant Field Values
-
MODAL
static final int MODAL
Open the window as MODAL- See Also:
- Constant Field Values
-
STANDALONE
static final int STANDALONE
The reporter is the only one in a window- See Also:
- Constant Field Values
-
BORDER
static final int BORDER
- See Also:
- Constant Field Values
-
SHOW_TOOLBAR
static final int SHOW_TOOLBAR
- See Also:
- Constant Field Values
-
MSG_TYPE_INFO
static final int MSG_TYPE_INFO
- See Also:
- Constant Field Values
-
MSG_TYPE_ERROR
static final int MSG_TYPE_ERROR
- See Also:
- Constant Field Values
-
MSG_TYPE_LOG
static final int MSG_TYPE_LOG
- See Also:
- Constant Field Values
-
-