Class CLIProgressMonitor
java.lang.Object
org.openstreetmap.josm.gui.progress.AbstractProgressMonitor
org.openstreetmap.josm.gui.progress.CLIProgressMonitor
- All Implemented Interfaces:
ProgressMonitor
CLI implementation of a
ProgressMonitor- Since:
- 18365
-
Nested Class Summary
Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.progress.AbstractProgressMonitor
AbstractProgressMonitor.StateNested classes/interfaces inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor
ProgressMonitor.CancelListener -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringThe custom text (prepended with '/')private StopwatchThe last time we updated the progress informationprivate StopwatchThe start time of the monitorprivate ProgressTaskIdThe current task idprivate StringThe current task titleFields inherited from class org.openstreetmap.josm.gui.progress.AbstractProgressMonitor
stateFields inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor
ALL_TICKS, DEFAULT_TICKS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidprotected voidprotected voiddoSetCustomText(String customText) protected voiddoSetIntermediate(boolean value) protected voiddoSetTitle(String title) Returns the task ID of the progress dialog Should be used only by PleaseWaitRunnableReturn the parent windows of progress dialogvoidsetProgressTaskId(ProgressTaskId taskId) Set the task ID of the progress dialog Should be used only by PleaseWaitRunnable.protected voidupdateProgress(double value) Update progress messageMethods inherited from class org.openstreetmap.josm.gui.progress.AbstractProgressMonitor
addCancelListener, appendLogMessage, beginTask, beginTask, cancel, checkState, childFinished, childSetCustomText, childSetIntermediate, childSetProgress, childSetTitle, createSubTaskMonitor, finishTask, getTicks, getTicksCount, indeterminateSubTask, invalidate, isCanceled, removeCancelListener, setCustomText, setExtraText, setTicks, setTicksCount, subTask, worked
-
Field Details
-
taskId
The current task id -
title
The current task title -
customText
The custom text (prepended with '/') -
lastUpdateTime
The last time we updated the progress information -
startTime
The start time of the monitor
-
-
Constructor Details
-
CLIProgressMonitor
public CLIProgressMonitor()Create a newCLIProgressMonitor
-
-
Method Details
-
doBeginTask
- Specified by:
doBeginTaskin classAbstractProgressMonitor
-
doFinishTask
- Specified by:
doFinishTaskin classAbstractProgressMonitor
-
doSetIntermediate
- Specified by:
doSetIntermediatein classAbstractProgressMonitor
-
doSetTitle
- Specified by:
doSetTitlein classAbstractProgressMonitor
-
doSetCustomText
- Specified by:
doSetCustomTextin classAbstractProgressMonitor
-
updateProgress
Description copied from class:AbstractProgressMonitorUpdate progress message- Specified by:
updateProgressin classAbstractProgressMonitor- Parameters:
value- The percentage of completion (this and child progress)
-
setProgressTaskId
Description copied from interface:ProgressMonitorSet the task ID of the progress dialog Should be used only by PleaseWaitRunnable. If taskId<> nullthen "In background" button will be shown- Parameters:
taskId- the task ID
-
getProgressTaskId
Description copied from interface:ProgressMonitorReturns the task ID of the progress dialog Should be used only by PleaseWaitRunnable- Returns:
- the task ID
-
getWindowParent
Description copied from interface:ProgressMonitorReturn the parent windows of progress dialog- Returns:
- component suitable as parent for dialogs that wants to be shown in front of progress dialog
-