|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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 IStatus |
blockedStatus
|
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 |
clearBlocked()
Clears the blocked state of the running operation. |
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)
Detach the progress monitor part from the given cancel component |
void |
setBlocked(IStatus reason)
Indicates that this operation is blocked by some background activity. |
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)
Notifies that a subtask of the main task is beginning. |
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, getDisplay, getStyle, isDisposed, 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 IStatus blockedStatus
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)
cancelComponent
- the control whose selection will
trigger a cancelpublic 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)
in
- the original String
protected void initialize(Layout layout, int progressIndicatorHeight)
null
the part's default layout is used.
layout
- The layoutfor the receiver.progressIndicatorHeight
- The suggested height of the indicatorpublic void internalWorked(double work)
IProgressMonitor.internalWorked
.
internalWorked
in interface IProgressMonitor
work
- the amound of work doneIProgressMonitor.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)
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.beginTask(java.lang.String, int)
public void subTask(String name)
IProgressMonitor
subTask
in interface IProgressMonitor
name
- the name (or description) of the subtaskprotected void updateLabel()
public void worked(int work)
IProgressMonitor.worked
.
worked
in interface IProgressMonitor
work
- the number of work units just completedIProgressMonitor.worked(int)
public void clearBlocked()
IProgressMonitorWithBlocking
setBlocked
, it must eventually call
clearBlocked
before the operation completes.
clearBlocked
in interface IProgressMonitorWithBlocking
IProgressMonitorWithBlocking.setBlocked(IStatus)
public void setBlocked(IStatus reason)
IProgressMonitorWithBlocking
setBlocked
, it must
eventually call clearBlocked
before the operation
completes.
If the caller is blocked by a currently executing job, this method will return
an IJobStatus
indicating the job that is currently blocking
the caller. If this blocking job is not known, this method will return a plain
informational IStatus
object.
setBlocked
in interface IProgressMonitorWithBlocking
reason
- an optional status object whose message describes the
reason why this operation is blocked, or null
if this
information is not available.IProgressMonitorWithBlocking.clearBlocked()
,
IJobStatus
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.