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 classes
These 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
FieldsModifier and TypeFieldDescriptionstatic final int
Automatically closes the window when the reporter is finished; this only takes effect when there is only 1 reporter in the windowstatic final int
static final int
When a reporter is added to the history liststatic final int
When a reporter is removed from the history liststatic final int
When a reporter that is already in the history list report an eventstatic final int
Open the window as MODALstatic final int
static final int
static final int
static final int
Default style bit for no stylesstatic final int
WhenProgressReporter.cancel()
is detectedstatic final int
WhenProgressReporter.dispose()
is calledstatic final int
WhenProgressReporter.setDone()
is detectedstatic final int
WhenProgressReporter.setErrorMessage(String)
is detectedstatic final int
Default event type indicating no eventstatic final int
WhenProgressReporter.setIndeterminate(boolean)
is detectedstatic final int
When any other property is modifiedstatic final int
WhenProgressReporter.retry()
is detectedstatic final String
Unless specified by the user for a particular reporter all reporters have this default typestatic final int
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 final int
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 final int
Default return value from a listener indicating the event has been received and processed successfullystatic final int
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 final int
static final int
The reporter is the only one in a window
-
Field Details
-
REPORTER_TYPE_DEFAULT
Unless specified by the user for a particular reporter all reporters have this default type- See Also:
-
REPORTER_VISIBILITY_USER
static final int REPORTER_VISIBILITY_USERThe 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:
-
REPORTER_VISIBILITY_SYSTEM
static final int REPORTER_VISIBILITY_SYSTEMA 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:
-
REPORT_TYPE_INIT
static final int REPORT_TYPE_INITDefault event type indicating no event- See Also:
-
REPORT_TYPE_CANCEL
static final int REPORT_TYPE_CANCELWhenProgressReporter.cancel()
is detected- See Also:
-
REPORT_TYPE_DONE
static final int REPORT_TYPE_DONEWhenProgressReporter.setDone()
is detected- See Also:
-
REPORT_TYPE_MODE_CHANGE
static final int REPORT_TYPE_MODE_CHANGEWhenProgressReporter.setIndeterminate(boolean)
is detected- See Also:
-
REPORT_TYPE_ERROR
static final int REPORT_TYPE_ERRORWhenProgressReporter.setErrorMessage(String)
is detected- See Also:
-
REPORT_TYPE_RETRY
static final int REPORT_TYPE_RETRYWhenProgressReporter.retry()
is detected- See Also:
-
REPORT_TYPE_PROPERTY_CHANGED
static final int REPORT_TYPE_PROPERTY_CHANGEDWhen any other property is modified- See Also:
-
REPORT_TYPE_DISPOSED
static final int REPORT_TYPE_DISPOSEDWhenProgressReporter.dispose()
is called- See Also:
-
RETVAL_OK
static final int RETVAL_OKDefault return value from a listener indicating the event has been received and processed successfully- See Also:
-
RETVAL_OK_TO_DISPOSE
static final int RETVAL_OK_TO_DISPOSEA 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:
-
MANAGER_EVENT_ADDED
static final int MANAGER_EVENT_ADDEDWhen a reporter is added to the history list- See Also:
-
MANAGER_EVENT_REMOVED
static final int MANAGER_EVENT_REMOVEDWhen a reporter is removed from the history list- See Also:
-
MANAGER_EVENT_UPDATED
static final int MANAGER_EVENT_UPDATEDWhen a reporter that is already in the history list report an event- See Also:
-
NONE
static final int NONEDefault style bit for no styles- See Also:
-
AUTO_CLOSE
static final int AUTO_CLOSEAutomatically closes the window when the reporter is finished; this only takes effect when there is only 1 reporter in the window- See Also:
-
MODAL
static final int MODALOpen the window as MODAL- See Also:
-
STANDALONE
static final int STANDALONEThe reporter is the only one in a window- See Also:
-
BORDER
static final int BORDER- See Also:
-
SHOW_TOOLBAR
static final int SHOW_TOOLBAR- See Also:
-
MSG_TYPE_INFO
static final int MSG_TYPE_INFO- See Also:
-
MSG_TYPE_ERROR
static final int MSG_TYPE_ERROR- See Also:
-
MSG_TYPE_LOG
static final int MSG_TYPE_LOG- See Also:
-