Package com.inet.viewer
Class Progress
java.lang.Object
com.inet.viewer.Progress
- All Implemented Interfaces:
Runnable
- Direct Known Subclasses:
ExportProgress
,PrinterJobProgress
Class for all progresses, which should be handled as a Progress of the report viewer. A progress
encapsulates a special task with a state (such as idle, running or complete) and a value
(23 of 120) of its progress. To start the progress call the
startProgress()
method and
the progress will perform its run method. In this method call setProgress(int)
, setTotalProgress(int)
,
setStatus(int)
to propagate the status of the progress.
The progress will be registered at the ProgressPool and will inform its listeners
about property changes such as its status, current step and total steps.
Depending on the progress type the progress will be displayed at the StatusBar
or not.- Since:
- 7.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The property ProgressIndeterminate for PropertyChangeEventsstatic final String
The property ProgressStatus for PropertyChangeEventsstatic final String
The property ProgressStep for PropertyChangeEventsstatic final String
The property ProgressTotal for PropertyChangeEventsprotected final PropertyChangeSupport
FOR INTERNAL USE ONLYstatic final int
The progress was canceledstatic final int
The progress was successfully completedstatic final int
The progress was canceled due to an errorstatic final int
The progress idlesstatic final int
The progress has been created but has not been started yetstatic final int
The progress has not been created yetstatic final int
The progress is runningstatic final int
The type is export progress, which means the progress will be shown as export progress in the status barstatic final int
The type is invisible, do not show this progress in the status bar *static final int
The type is navigation progress, which means the progress will be shown as navigation progress in the status barstatic final int
The type is print progress, which means the progress will be shown as printing progress in the status barstatic final int
The type is search progress, which means the progress will be shown as search progress in the status bar -
Constructor Summary
ConstructorDescriptionProgress
(ReportView reportView, int type) Creates a new progress object with the given type and sets it as being "indeterminate" (that is, a "busy"/"not busy" progress) or determinate (that is, with clearly defined steps - step 1 of 5, step 2 of 5, etc.)Progress
(Component parent, ViewerContext viewerContext, int type) Creates a new progress object with the given type and sets it as being "indeterminate" (that is, a "busy"/"not busy" progress) or determinate (that is, with clearly defined steps - step 1 of 5, step 2 of 5, etc.) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a PropertyChangeListener to this progress.abstract void
cancel()
Call this method to force a cancel of the progress - which must also set both of the states "finished" and "canceled" to true.protected void
cleanUp()
Final clean up of the progress: unregister all property change listeners, etc.Returns the last error message of this Progress.abstract String
getName()
The name of the daemon thread.int
Use this method to get the current step of this progress .Returns the ReportView to which this progress belongs.int
Returns the status of this Progress.int
Use this method to get the total steps (e.g. pages) to go.int
getType()
Returns the type of the progress, which can be one of the following types.boolean
Returns whether this progress has been canceled - progresses which can be canceled should overload this method.boolean
Returns whether this progress has been stopped due to an error - progresses which can be stopped due to an error should overload this method.boolean
Return true if the progress has stopped its task.boolean
Returns whether this progress is indeterminate, that is, only a "busy" or "not busy" progress.void
Removes a PropertyChangeListener from this progress.void
setErrorMessage
(String msg) Sets an error message for this progress to pass failure information to the viewer.void
setIndeterminate
(boolean indeterminate) Set the status of the progress to indeterminate or determined.void
setProgress
(int step) Use this method to set the progress and to inform all registered listeners about the current step.void
setStatus
(int status) Call this method to set the status of this progress.void
setTotalProgress
(int total) Use this method to inform all registered listeners about the total steps (e.g. pages) to go.void
Shows an error dialog for this error message.final void
Call this method to start the progress.void
This method will block until the progress has finished it task.
-
Field Details
-
TYPE_PAGELOADER
public static final int TYPE_PAGELOADERThe type is navigation progress, which means the progress will be shown as navigation progress in the status bar- Since:
- 7.0
- See Also:
-
TYPE_PRINT
public static final int TYPE_PRINTThe type is print progress, which means the progress will be shown as printing progress in the status bar- Since:
- 7.0
- See Also:
-
TYPE_EXPORT
public static final int TYPE_EXPORTThe type is export progress, which means the progress will be shown as export progress in the status bar- Since:
- 7.0
- See Also:
-
TYPE_SEARCH
public static final int TYPE_SEARCHThe type is search progress, which means the progress will be shown as search progress in the status bar- Since:
- 7.0
- See Also:
-
TYPE_INVISIBLE
public static final int TYPE_INVISIBLEThe type is invisible, do not show this progress in the status bar *- Since:
- 7.0
- See Also:
-
STATUS_NOT_INITIALIZED
public static final int STATUS_NOT_INITIALIZEDThe progress has not been created yet- Since:
- 7.0
- See Also:
-
STATUS_INITIALIZED
public static final int STATUS_INITIALIZEDThe progress has been created but has not been started yet- Since:
- 7.0
- See Also:
-
STATUS_RUNNING
public static final int STATUS_RUNNINGThe progress is running- Since:
- 7.0
- See Also:
-
STATUS_COMPLETED
public static final int STATUS_COMPLETEDThe progress was successfully completed- Since:
- 7.0
- See Also:
-
STATUS_CANCELED
public static final int STATUS_CANCELEDThe progress was canceled- Since:
- 7.0
- See Also:
-
STATUS_ERROR
public static final int STATUS_ERRORThe progress was canceled due to an error- Since:
- 7.0
- See Also:
-
STATUS_IDLE
public static final int STATUS_IDLEThe progress idles- Since:
- 7.0
- See Also:
-
PROP_PROGRESS_STATUS
The property ProgressStatus for PropertyChangeEvents- Since:
- 7.0
- See Also:
-
PROP_PROGRESS_TOTAL
The property ProgressTotal for PropertyChangeEvents- Since:
- 7.0
- See Also:
-
PROP_PROGRESS_STEP
The property ProgressStep for PropertyChangeEvents- Since:
- 7.0
- See Also:
-
PROP_PROGRESS_INDETERMINATE
The property ProgressIndeterminate for PropertyChangeEvents- Since:
- 7.0
- See Also:
-
propertySupporter
FOR INTERNAL USE ONLY
-
-
Constructor Details
-
Progress
Creates a new progress object with the given type and sets it as being "indeterminate" (that is, a "busy"/"not busy" progress) or determinate (that is, with clearly defined steps - step 1 of 5, step 2 of 5, etc.) The Progress will register itself to the viewer ProgressPool, which handles all progresses.- Parameters:
reportView
- The ReportView of this progress.type
- E.g. NAVIGATION, PRINT, EXPORT, SEARCH or a custom defined constant.- Since:
- 7.0
-
Progress
Creates a new progress object with the given type and sets it as being "indeterminate" (that is, a "busy"/"not busy" progress) or determinate (that is, with clearly defined steps - step 1 of 5, step 2 of 5, etc.) This Progress will NOT registered to the viewer ProgressPool. It is useful for export without report preview.- Parameters:
parent
- Component, used for showErrorviewerContext
- ViewerContext, used for showErrortype
- E.g. NAVIGATION, PRINT, EXPORT, SEARCH or a custom defined constant.- Since:
- 7.6
-
-
Method Details
-
startProgress
public final void startProgress()Call this method to start the progress. The progress will register itself at the ProgressPool of the Viewer.- Throws:
ViewerException
- when progress is already running- Since:
- 7.0
-
getName
The name of the daemon thread.- Returns:
- the name of the daemon thread.
- Since:
- 7.0
-
cancel
public abstract void cancel()Call this method to force a cancel of the progress - which must also set both of the states "finished" and "canceled" to true. Please note: some progresses may not be stoppable.- Since:
- 7.0
-
getType
public int getType()Returns the type of the progress, which can be one of the following types.- Returns:
- Type of the progress
- Since:
- 7.0
- See Also:
-
waitUntilFinished
public void waitUntilFinished()This method will block until the progress has finished it task.- Since:
- 7.0
-
isIndeterminate
public boolean isIndeterminate()Returns whether this progress is indeterminate, that is, only a "busy" or "not busy" progress. If not, this progress has specific steps and can be determined how far it is finished.- Returns:
- Whether this progress is indeterminate, that is, only a "busy" or "not busy" progress.
- Since:
- 7.0
-
setIndeterminate
public void setIndeterminate(boolean indeterminate) Set the status of the progress to indeterminate or determined.- Parameters:
indeterminate
- True if the progress should be indeterminate.- Since:
- 7.0
-
setStatus
public void setStatus(int status) Call this method to set the status of this progress. The status could beSTATUS_INITIALIZED
,STATUS_RUNNING
,STATUS_IDLE
,STATUS_CANCELED
,STATUS_COMPLETED
,STATUS_ERROR
. If the status isSTATUS_ERROR
usedsetErrorMessage(String)
,showError(Throwable)
to give a reason for this error. All registered listeners will be informed about this change.- Parameters:
status
- Status of this progress- Since:
- 7.0
-
isFinished
public boolean isFinished()Return true if the progress has stopped its task. The status of the Progress can be complete, canceled or error.- Returns:
- whether the progress has stopped
- Since:
- 7.0
-
isCanceled
public boolean isCanceled()Returns whether this progress has been canceled - progresses which can be canceled should overload this method.- Returns:
- Whether this progress has been canceled
- Since:
- 7.0
-
isErrored
public boolean isErrored()Returns whether this progress has been stopped due to an error - progresses which can be stopped due to an error should overload this method.- Returns:
- Whether this progress has been stopped due to an error
- Since:
- 7.0
-
setTotalProgress
public void setTotalProgress(int total) Use this method to inform all registered listeners about the total steps (e.g. pages) to go. If total is set to zero the progress will be declared as inactive (status = Progress.STATUS_IDLE).- Parameters:
total
- steps to go- Since:
- 7.0
-
getTotalProgress
public int getTotalProgress()Use this method to get the total steps (e.g. pages) to go.- Returns:
- steps to go
- Since:
- 7.0
-
setProgress
public void setProgress(int step) Use this method to set the progress and to inform all registered listeners about the current step.- Parameters:
step
- Steps made in the progress so far (1-based)- Since:
- 7.0
-
getProgress
public int getProgress()Use this method to get the current step of this progress .- Returns:
- current step of the progress
- Since:
- 7.0
-
getReportView
Returns the ReportView to which this progress belongs.- Returns:
- The ReportView of this progress.
- Since:
- 7.0
-
getStatus
public int getStatus()Returns the status of this Progress. The could beSTATUS_INITIALIZED
,STATUS_RUNNING
,STATUS_IDLE
,STATUS_CANCELED
,STATUS_COMPLETED
,STATUS_ERROR
- Returns:
- Return the status of this Progress
- Since:
- 7.0
-
getErrorMessage
Returns the last error message of this Progress.- Returns:
- The last error of this Progress.
- Since:
- 7.0
-
setErrorMessage
Sets an error message for this progress to pass failure information to the viewer.- Parameters:
msg
- error message- Since:
- 7.0
-
showError
Shows an error dialog for this error message. If there is no ReportView it will print a stacktrace to the console. It is calling setErrorMessage(String) and setStatus(STATUS_ERROR) before the error message is show.- Parameters:
th
- The exception to show in the error dialog.- Since:
- 7.0
- See Also:
-
addPropertyChangeListener
Adds a PropertyChangeListener to this progress. All registered listeners will be informed if the status of the progress changes.- Parameters:
l
- PropertyChangeListener- Since:
- 7.0
-
removePropertyChangeListener
Removes a PropertyChangeListener from this progress.- Parameters:
l
- PropertyChangeListener- Since:
- 7.0
-
cleanUp
protected void cleanUp()Final clean up of the progress: unregister all property change listeners, etc.- Since:
- 8.0
-