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 Details

    • REPORTER_TYPE_DEFAULT

      static final String 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_USER
      The default visibility for a ProgressReporter; this is the most generous visibility level in that any interested processes can see this reporter and receive it's ProgressReporter.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_SYSTEM
      A hint to the ProgressReportingManager 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_INIT
      Default event type indicating no event
      See Also:

    • REPORT_TYPE_CANCEL

      static final int REPORT_TYPE_CANCEL
      When ProgressReporter.cancel() is detected
      See Also:

    • REPORT_TYPE_DONE

      static final int REPORT_TYPE_DONE
      When ProgressReporter.setDone() is detected
      See Also:

    • REPORT_TYPE_MODE_CHANGE

      static final int REPORT_TYPE_MODE_CHANGE
      When ProgressReporter.setIndeterminate(boolean) is detected
      See Also:

    • REPORT_TYPE_ERROR

      static final int REPORT_TYPE_ERROR
      When ProgressReporter.setErrorMessage(String) is detected
      See Also:

    • REPORT_TYPE_RETRY

      static final int REPORT_TYPE_RETRY
      When ProgressReporter.retry() is detected
      See Also:

    • REPORT_TYPE_PROPERTY_CHANGED

      static final int REPORT_TYPE_PROPERTY_CHANGED
      When any other property is modified
      See Also:

    • REPORT_TYPE_DISPOSED

      static final int REPORT_TYPE_DISPOSED
      When ProgressReporter.dispose() is called
      See Also:

    • RETVAL_OK

      static final int RETVAL_OK
      Default 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_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:

    • MANAGER_EVENT_ADDED

      static final int MANAGER_EVENT_ADDED
      When a reporter is added to the history list
      See Also:

    • MANAGER_EVENT_REMOVED

      static final int MANAGER_EVENT_REMOVED
      When a reporter is removed from the history list
      See Also:

    • MANAGER_EVENT_UPDATED

      static final int MANAGER_EVENT_UPDATED
      When a reporter that is already in the history list report an event
      See Also:

    • NONE

      static final int NONE
      Default style bit for no styles
      See Also:

    • 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:

    • STANDALONE

      static final int STANDALONE
      The 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: