net.enilink.commons.ui.progress

Class UiProgressMonitorWrapper

java.lang.Object

net.enilink.commons.ui.progress.UiProgressMonitorWrapper

All Implemented Interfaces:

org.eclipse.core.runtime.IProgressMonitor, org.eclipse.core.runtime.IProgressMonitorWithBlocking

public class UiProgressMonitorWrapper
extends Object
implements org.eclipse.core.runtime.IProgressMonitor, org.eclipse.core.runtime.IProgressMonitorWithBlocking

An wrapper around a progress monitor which, unless overridden, forwards IProgressMonitor and IProgressMonitorWithBlocking methods to the wrapped progress monitor and runs this methods in the display thread.

This class can be used without OSGi running.

Clients may subclass.

Field Summary

Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
UiProgressMonitorWrapper(org.eclipse.core.runtime.IProgressMonitor monitor, org.eclipse.swt.widgets.Display display) Creates a new wrapper around the given monitor.

Method Summary

Modifier and Type	Method and Description
void	beginTask(String name, int totalWork) This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
void	clearBlocked() This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor.
void	done() This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
org.eclipse.core.runtime.IProgressMonitor	getWrappedProgressMonitor() Returns the wrapped progress monitor.
void	internalWorked(double work) This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
boolean	isCanceled() This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
void	setBlocked(org.eclipse.core.runtime.IStatus reason) This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor.
void	setCanceled(boolean b) This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
void	setTaskName(String name) This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
void	subTask(String name) This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
void	worked(int work) This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.core.runtime.IProgressMonitor

done, nullSafe, slice

Constructor Detail

UiProgressMonitorWrapper

public UiProgressMonitorWrapper(org.eclipse.core.runtime.IProgressMonitor monitor,
                                org.eclipse.swt.widgets.Display display)

Creates a new wrapper around the given monitor.

Parameters:

monitor - the progress monitor to forward to

Method Detail

beginTask

public void beginTask(String name,
                      int totalWork)

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

beginTask in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.beginTask(String, int)

clearBlocked

public void clearBlocked()

This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

clearBlocked in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.clearBlocked()

done

public void done()

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

done in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.done()

getWrappedProgressMonitor

public org.eclipse.core.runtime.IProgressMonitor getWrappedProgressMonitor()

Returns the wrapped progress monitor.

Returns:

the wrapped progress monitor

internalWorked

public void internalWorked(double work)

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

internalWorked in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.internalWorked(double)

isCanceled

public boolean isCanceled()

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

isCanceled in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.isCanceled()

setBlocked

public void setBlocked(org.eclipse.core.runtime.IStatus reason)

This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

setBlocked in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.setBlocked(IStatus)

setCanceled

public void setCanceled(boolean b)

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

setCanceled in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.setCanceled(boolean)

setTaskName

public void setTaskName(String name)

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

setTaskName in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.setTaskName(String)

subTask

public void subTask(String name)

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

subTask in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.subTask(String)

worked

public void worked(int work)

This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.

Specified by:

worked in interface org.eclipse.core.runtime.IProgressMonitor

See Also:

IProgressMonitor.worked(int)