|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openstreetmap.josm.gui.progress.NullProgressMonitor
public class NullProgressMonitor
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor |
---|
ProgressMonitor.CancelListener |
Field Summary | |
---|---|
static ProgressMonitor |
INSTANCE
|
Fields inherited from interface org.openstreetmap.josm.gui.progress.ProgressMonitor |
---|
ALL_TICKS, DEFAULT_TICKS |
Constructor Summary | |
---|---|
private |
NullProgressMonitor()
|
Method Summary | |
---|---|
void |
addCancelListener(ProgressMonitor.CancelListener listener)
|
void |
appendLogMessage(java.lang.String message)
Appends a message to the log managed by the progress monitor. |
void |
beginTask(java.lang.String title)
|
void |
beginTask(java.lang.String title,
int ticks)
Starts this progress monitor. |
void |
cancel()
|
ProgressMonitor |
createSubTaskMonitor(int ticks,
boolean internal)
Creates subtasks monitor. |
void |
finishTask()
Finish this progress monitor, close the dialog or inform the parent progress monitor that it can continue with other tasks. |
java.lang.String |
getErrorMessage()
|
ProgressTaskId |
getProgressTaskId()
Should be used only by PleaseWaitRunnable |
int |
getTicks()
|
int |
getTicksCount()
|
java.awt.Component |
getWindowParent()
|
void |
indeterminateSubTask(java.lang.String title)
Subtask that will show progress running back and forth |
void |
invalidate()
Can be used if method receive ProgressMonitor but it's not interested progress monitoring. |
boolean |
isCanceled()
|
void |
removeCancelListener(ProgressMonitor.CancelListener listener)
|
void |
setCustomText(java.lang.String text)
Shows additional text |
void |
setErrorMessage(java.lang.String message)
|
void |
setExtraText(java.lang.String text)
Show extra text after normal task title. |
void |
setProgressTaskId(ProgressTaskId taskId)
Should be used only by PleaseWaitRunnable. |
void |
setSilent(boolean value)
|
void |
setTicks(int ticks)
|
void |
setTicksCount(int ticks)
|
void |
subTask(java.lang.String title)
Normal subtask |
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 |
Field Detail |
---|
public static final ProgressMonitor INSTANCE
Constructor Detail |
---|
private NullProgressMonitor()
Method Detail |
---|
public void addCancelListener(ProgressMonitor.CancelListener listener)
addCancelListener
in interface ProgressMonitor
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 cancel()
cancel
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
public void finishTask()
ProgressMonitor
finishTask
in interface ProgressMonitor
public java.lang.String getErrorMessage()
public int getTicks()
getTicks
in interface ProgressMonitor
public void indeterminateSubTask(java.lang.String title)
ProgressMonitor
indeterminateSubTask
in interface ProgressMonitor
title
- Can be null, in that case task title is not changedpublic 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 boolean isCanceled()
isCanceled
in interface ProgressMonitor
public void removeCancelListener(ProgressMonitor.CancelListener listener)
removeCancelListener
in interface ProgressMonitor
public void setCustomText(java.lang.String text)
ProgressMonitor
setCustomText
in interface ProgressMonitor
public void setErrorMessage(java.lang.String message)
public void setExtraText(java.lang.String text)
ProgressMonitor
setExtraText
in interface ProgressMonitor
public void appendLogMessage(java.lang.String message)
ProgressMonitor
appendLogMessage
in interface ProgressMonitor
message
- the log message. Ignored if null or white space only.public void setSilent(boolean 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 subTask(java.lang.String title)
ProgressMonitor
subTask
in interface ProgressMonitor
title
- Can be null, in that case task title is not changedpublic void worked(int ticks)
ProgressMonitor
worked
in interface ProgressMonitor
public int getTicksCount()
getTicksCount
in interface ProgressMonitor
public void setProgressTaskId(ProgressTaskId taskId)
ProgressMonitor
setProgressTaskId
in interface ProgressMonitor
public ProgressTaskId getProgressTaskId()
ProgressMonitor
getProgressTaskId
in interface ProgressMonitor
public java.awt.Component getWindowParent()
getWindowParent
in interface ProgressMonitor
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |