|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openstreetmap.josm.gui.progress.AbstractProgressMonitor
public abstract class AbstractProgressMonitor
Nested Class Summary | |
---|---|
private static class |
AbstractProgressMonitor.Request
|
protected static class |
AbstractProgressMonitor.State
|
Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor |
---|
ProgressMonitor.CancelListener |
Field Summary | |
---|---|
private CancelHandler |
cancelHandler
|
private int |
childTicks
|
private AbstractProgressMonitor |
currentChild
|
private java.lang.String |
customText
|
private java.lang.String |
extraText
|
private boolean |
intermediateTask
|
private AbstractProgressMonitor.Request |
requestedState
|
private java.util.Queue<AbstractProgressMonitor.Request> |
requests
|
private java.lang.String |
shownCustomText
|
private java.lang.String |
shownTitle
|
protected AbstractProgressMonitor.State |
state
|
private java.lang.String |
taskTitle
|
(package private) int |
ticks
|
(package private) int |
ticksCount
|
Fields inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor |
---|
ALL_TICKS, DEFAULT_TICKS |
Constructor Summary | |
---|---|
protected |
AbstractProgressMonitor(CancelHandler cancelHandler)
|
Method Summary | |
---|---|
void |
addCancelListener(ProgressMonitor.CancelListener listener)
|
void |
appendLogMessage(java.lang.String message)
Default implementation is empty. |
private void |
applyChildRequest(AbstractProgressMonitor.Request request)
|
private void |
applyThisRequest(AbstractProgressMonitor.Request request)
|
void |
beginTask(java.lang.String title)
|
void |
beginTask(java.lang.String title,
int ticks)
Starts this progress monitor. |
void |
cancel()
|
protected void |
checkState(AbstractProgressMonitor.State... expectedStates)
|
protected void |
childFinished(AbstractProgressMonitor child)
|
protected void |
childSetCustomText(AbstractProgressMonitor child,
java.lang.String customText)
|
protected void |
childSetIntermediate(AbstractProgressMonitor child,
boolean value)
|
protected void |
childSetProgress(AbstractProgressMonitor child,
double value)
|
protected void |
childSetTitle(AbstractProgressMonitor child,
java.lang.String title)
|
ProgressMonitor |
createSubTaskMonitor(int ticks,
boolean internal)
Creates subtasks monitor. |
protected abstract void |
doBeginTask()
|
protected abstract void |
doFinishTask()
|
protected abstract void |
doSetCustomText(java.lang.String title)
|
protected abstract void |
doSetIntermediate(boolean value)
|
protected abstract void |
doSetTitle(java.lang.String title)
|
void |
finishTask()
Finish this progress monitor, close the dialog or inform the parent progress monitor that it can continue with other tasks. |
private AbstractProgressMonitor.Request |
getRequest(AbstractProgressMonitor child)
|
int |
getTicks()
|
int |
getTicksCount()
|
void |
indeterminateSubTask(java.lang.String title)
Subtask that will show progress running back and forth |
private void |
internalUpdateProgress(double childProgress)
|
void |
invalidate()
Can be used if method receive ProgressMonitor but it's not interested progress monitoring. |
boolean |
isCanceled()
|
void |
removeCancelListener(ProgressMonitor.CancelListener listener)
|
private void |
resetState()
|
void |
setCustomText(java.lang.String text)
Shows additional text |
void |
setExtraText(java.lang.String text)
Show extra text after normal task title. |
void |
setTicks(int ticks)
|
void |
setTicksCount(int ticks)
|
void |
subTask(java.lang.String title)
Normal subtask |
(package private) abstract void |
updateProgress(double value)
|
void |
worked(int ticks)
Increase number of already done work units by ticks |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor |
---|
getProgressTaskId, getWindowParent, setProgressTaskId |
Field Detail |
---|
private final CancelHandler cancelHandler
protected AbstractProgressMonitor.State state
int ticksCount
int ticks
private int childTicks
private java.lang.String taskTitle
private java.lang.String customText
private java.lang.String extraText
private java.lang.String shownTitle
private java.lang.String shownCustomText
private boolean intermediateTask
private java.util.Queue<AbstractProgressMonitor.Request> requests
private AbstractProgressMonitor currentChild
private AbstractProgressMonitor.Request requestedState
Constructor Detail |
---|
protected AbstractProgressMonitor(CancelHandler cancelHandler)
Method Detail |
---|
protected abstract void doBeginTask()
protected abstract void doFinishTask()
protected abstract void doSetIntermediate(boolean value)
protected abstract void doSetTitle(java.lang.String title)
protected abstract void doSetCustomText(java.lang.String title)
protected void checkState(AbstractProgressMonitor.State... expectedStates)
public void beginTask(java.lang.String title)
beginTask
in interface ProgressMonitor
public void beginTask(java.lang.String title, int ticks)
ProgressMonitor
beginTask
in interface ProgressMonitor
public void finishTask()
ProgressMonitor
finishTask
in interface ProgressMonitor
public void invalidate()
ProgressMonitor
ProgressMonitor.beginTask(String)
and ProgressMonitor.finishTask()
This method can be also used in finally section if method expects that some exception
might prevent it from passing progressMonitor away. If ProgressMonitor.beginTask(String)
was
already called then this method does nothing.
invalidate
in interface ProgressMonitor
public void subTask(java.lang.String title)
ProgressMonitor
subTask
in interface ProgressMonitor
title
- Can be null, in that case task title is not changedpublic void indeterminateSubTask(java.lang.String title)
ProgressMonitor
indeterminateSubTask
in interface ProgressMonitor
title
- Can be null, in that case task title is not changedpublic void setCustomText(java.lang.String text)
ProgressMonitor
setCustomText
in interface ProgressMonitor
public void setExtraText(java.lang.String text)
ProgressMonitor
setExtraText
in interface ProgressMonitor
public void appendLogMessage(java.lang.String message)
appendLogMessage
in interface ProgressMonitor
message
- the log message. Ignored if null or white space only.private void resetState()
public void cancel()
cancel
in interface ProgressMonitor
public boolean isCanceled()
isCanceled
in interface ProgressMonitor
public void addCancelListener(ProgressMonitor.CancelListener listener)
addCancelListener
in interface ProgressMonitor
public void removeCancelListener(ProgressMonitor.CancelListener listener)
removeCancelListener
in interface ProgressMonitor
abstract void updateProgress(double value)
public void setTicks(int ticks)
setTicks
in interface ProgressMonitor
ticks
- Number of work units already donepublic void setTicksCount(int ticks)
setTicksCount
in interface ProgressMonitor
ticks
- Number of total work unitspublic void worked(int ticks)
ProgressMonitor
worked
in interface ProgressMonitor
private void internalUpdateProgress(double childProgress)
public int getTicks()
getTicks
in interface ProgressMonitor
public int getTicksCount()
getTicksCount
in interface ProgressMonitor
public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal)
ProgressMonitor
createSubTaskMonitor
in interface ProgressMonitor
ticks
- Number of work units that should be done when subtask finishesinternal
- If true then subtask can't modify task title/custom text
private void applyChildRequest(AbstractProgressMonitor.Request request)
private void applyThisRequest(AbstractProgressMonitor.Request request)
protected void childFinished(AbstractProgressMonitor child)
private AbstractProgressMonitor.Request getRequest(AbstractProgressMonitor child)
protected void childSetProgress(AbstractProgressMonitor child, double value)
protected void childSetTitle(AbstractProgressMonitor child, java.lang.String title)
protected void childSetCustomText(AbstractProgressMonitor child, java.lang.String customText)
protected void childSetIntermediate(AbstractProgressMonitor child, boolean value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |