|
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.swt.widgets.Widget | +--org.eclipse.swt.widgets.Control | +--org.eclipse.swt.widgets.Scrollable | +--org.eclipse.swt.widgets.Composite | +--org.eclipse.jface.wizard.ProgressMonitorPart
A standard implementation of an IProgressMonitor. It consists
of a label displaying the task and subtask name, and a
progress indicator to show progress. In contrast to
ProgressMonitorDialog
this class only implements
IProgressMonitor
.
Field Summary | |
protected Control |
fCancelComponent
|
protected Listener |
fCancelListener
|
protected boolean |
fIsCanceled
|
protected Label |
fLabel
|
protected ProgressIndicator |
fProgressIndicator
|
protected String |
fSubTaskName
|
protected String |
fTaskName
|
Fields inherited from class org.eclipse.swt.widgets.Control |
handle |
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor |
UNKNOWN |
Constructor Summary | |
ProgressMonitorPart(Composite parent,
Layout layout)
Creates a ProgressMonitorPart. |
|
ProgressMonitorPart(Composite parent,
Layout layout,
int progressIndicatorHeight)
Creates a ProgressMonitorPart. |
Method Summary | |
void |
attachToCancelComponent(Control cancelComponent)
Attaches the progress monitor part to the given cancel component. |
void |
beginTask(String name,
int totalWork)
Implements IProgressMonitor.beginTask . |
void |
done()
Implements IProgressMonitor.done . |
protected static String |
escapeMetaCharacters(String in)
Escapes any occurrence of '&' in the given String so that it is not considered as a mnemonic character in SWT ToolItems, MenuItems, Button and Labels. |
protected void |
initialize(Layout layout,
int progressIndicatorHeight)
Creates the progress monitor's UI parts and layouts them according to the given layout. |
void |
internalWorked(double work)
Implements IProgressMonitor.internalWorked . |
boolean |
isCanceled()
Implements IProgressMonitor.isCanceled . |
void |
removeFromCancelComponent(Control cc)
Detached the progress monitor part to the given cancel component |
void |
setCanceled(boolean b)
Implements IProgressMonitor.setCanceled . |
void |
setFont(Font font)
Sets the progress monitor part's font. |
void |
setTaskName(String name)
Sets the task name to the given value. |
void |
subTask(String name)
Implements IProgressMonitor.subTask . |
protected void |
updateLabel()
Updates the label with the current task and subtask names. |
void |
worked(int work)
Implements IProgressMonitor.worked . |
Methods inherited from class org.eclipse.swt.widgets.Composite |
checkSubclass, computeSize, getChildren, getLayout, getTabList, layout, layout, setFocus, setLayout, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getStyle, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected Label fLabel
protected String fTaskName
protected String fSubTaskName
protected ProgressIndicator fProgressIndicator
protected Control fCancelComponent
protected boolean fIsCanceled
protected Listener fCancelListener
Constructor Detail |
public ProgressMonitorPart(Composite parent, Layout layout)
parent
- The SWT parent of the part.layout
- The SWT grid bag layout used by the part. A client
can supply the layout to control how the progress monitor part
is layed out. If null is passed the part uses its default layout.public ProgressMonitorPart(Composite parent, Layout layout, int progressIndicatorHeight)
parent
- The SWT parent of the part.layout
- The SWT grid bag layout used by the part. A client
can supply the layout to control how the progress monitor part
is layed out. If null is passed the part uses its default layout.progressIndicatorHeight
- The height of the progress indicator in pixel.Method Detail |
public void attachToCancelComponent(Control cancelComponent)
public void beginTask(String name, int totalWork)
IProgressMonitor.beginTask
.
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(java.lang.String, int)
public void done()
IProgressMonitor.done
.
done
in interface IProgressMonitor
IProgressMonitor.done()
protected static String escapeMetaCharacters(String in)
protected void initialize(Layout layout, int progressIndicatorHeight)
null
the part's default layout is used.
public void internalWorked(double work)
IProgressMonitor.internalWorked
.
internalWorked
in interface IProgressMonitor
IProgressMonitor.internalWorked(double)
public boolean isCanceled()
IProgressMonitor.isCanceled
.
isCanceled
in interface IProgressMonitor
true
if cancellation has been requested,
and false
otherwiseIProgressMonitor.isCanceled()
public void removeFromCancelComponent(Control cc)
public void setCanceled(boolean b)
IProgressMonitor.setCanceled
.
setCanceled
in interface IProgressMonitor
b
- true
indicates that cancelation has
been requested (but not necessarily acknowledged);
false
clears this flagIProgressMonitor.setCanceled(boolean)
public void setFont(Font font)
setFont
in class Control
font
- the new font (or null)public void setTaskName(String name)
IProgressMonitor
setTaskName
in interface IProgressMonitor
name
- the name (or description) of the main taskIProgressMonitor.setTaskName(java.lang.String)
public void subTask(String name)
IProgressMonitor.subTask
.
subTask
in interface IProgressMonitor
name
- the name (or description) of the subtaskIProgressMonitor.subTask(java.lang.String)
protected void updateLabel()
public void worked(int work)
IProgressMonitor.worked
.
worked
in interface IProgressMonitor
work
- the number of work units just completedIProgressMonitor.worked(int)
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |