|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.update.core.InstallMonitor
Install progress monitor Delegating wrapper for IProgressMonitor used for installation handling.
Field Summary |
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor |
UNKNOWN |
Constructor Summary | |
InstallMonitor(IProgressMonitor monitor)
Install monitor constructor |
Method Summary | |
void |
beginTask(String name,
int totalWork)
Begin new monitor task. |
void |
done()
Indicate completion of monitor activity. |
void |
internalWorked(double work)
Indicate monitor progress. |
boolean |
isCanceled()
Check is use indicated that the operation be cancelled. |
void |
restoreState()
Restore the monitor state. |
void |
saveState()
Save the current monitor state. |
void |
setCanceled(boolean value)
Set the cancellation state. |
void |
setCopyCount(long count)
Sets the number of bytes already copied. |
void |
setTaskName(String name)
Set task name. |
void |
setTotalCount(long count)
Sets the total number of bytes to copy. |
void |
showCopyDetails(boolean setting)
Indicate whether the monitor subtask message should include copy progress counts. |
void |
subTask(String name)
Set subtask name. |
void |
worked(int work)
Indicate monitor progress. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public InstallMonitor(IProgressMonitor monitor)
monitor
- base install monitorMethod Detail |
public void beginTask(String name, int totalWork)
beginTask
in interface IProgressMonitor
name
- the name (or description) of the main tasktotalWork
- the total number of work units into which
the main task is been subdivided. If the value is UNKNOWN
the implemenation is free to indicate progress in a way which
doesn't require the total number of work units in advance.IProgressMonitor.beginTask(String, int)
public void done()
done
in interface IProgressMonitor
IProgressMonitor.done()
public void internalWorked(double work)
internalWorked
in interface IProgressMonitor
IProgressMonitor.internalWorked(double)
public boolean isCanceled()
isCanceled
in interface IProgressMonitor
true
if cancellation has been requested,
and false
otherwiseIProgressMonitor.isCanceled()
public void setCanceled(boolean value)
setCanceled
in interface IProgressMonitor
value
- true
indicates that cancelation has
been requested (but not necessarily acknowledged);
false
clears this flagIProgressMonitor.setCanceled(boolean)
public void setTaskName(String name)
setTaskName
in interface IProgressMonitor
name
- the name (or description) of the main taskIProgressMonitor.setTaskName(String)
public void subTask(String name)
subTask
in interface IProgressMonitor
name
- the name (or description) of the subtaskIProgressMonitor.subTask(String)
public void worked(int work)
worked
in interface IProgressMonitor
work
- the number of work units just completedIProgressMonitor.worked(int)
public void saveState()
restoreState()
public void restoreState()
saveState()
public void showCopyDetails(boolean setting)
setting
- true
to show the copy count,
false
otherwisesetCopyCount(long)
,
setTotalCount(long)
public void setTotalCount(long count)
count
- total number of bytes to copy.showCopyDetails(boolean)
,
setCopyCount(long)
public void setCopyCount(long count)
count
- number of bytes already copied.showCopyDetails(boolean)
,
setTotalCount(long)
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |