Interface IProgressReportConstants

    • 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 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:
        Constant Field Values
      • 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:
        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_PROPERTY_CHANGED

        static final int REPORT_TYPE_PROPERTY_CHANGED
        When any other property is modified
        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
      • 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
      • STANDALONE

        static final int STANDALONE
        The reporter is the only one in a window
        See Also:
        Constant Field Values