com.vividsolutions.jump.workbench.ui.plugin.test

Class ProgressReportingPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn

com.vividsolutions.jump.workbench.ui.plugin.test.ProgressReportingPlugIn

All Implemented Interfaces:

PlugIn, ThreadedPlugIn

public class ProgressReportingPlugIn
extends ThreadedBasePlugIn

Constructor Summary

Constructors

Constructor and Description
ProgressReportingPlugIn()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(PlugInContext context) Performs the action for this plugin.
void	initialize(PlugInContext context) Called when Workbench starts up to allow plugins to initialize themselves.
void	run(TaskMonitor monitor, PlugInContext context) Runs the task.

Methods inherited from class com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn

main

Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

createName, execute, execute, getName, isRollingBackInvalidEdits, reportNothingToUndoYet, toActionListener, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vividsolutions.jump.workbench.plugin.PlugIn

getName

Constructor Detail

ProgressReportingPlugIn

public ProgressReportingPlugIn()

Method Detail

initialize

public void initialize(PlugInContext context)
                throws Exception

Description copied from interface: PlugIn

Called when Workbench starts up to allow plugins to initialize themselves.

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractPlugIn

Throws:

Exception

execute

public boolean execute(PlugInContext context)
                throws Exception

Description copied from interface: PlugIn

Performs the action for this plugin. For threaded plugins with dialogs, this method contains the code to invoke the dialog. If the user cancels the dialog, this method should return false to prevent the run method from being called.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractPlugIn

Returns:

true if the action completed, false if it was aborted. Used by ThreadedPlugIns to indicate that their #run method needn't be called next.

Throws:

Exception - if a problem occurs during plug-in execution

See Also:

ThreadedPlugIn

run

public void run(TaskMonitor monitor,
       PlugInContext context)

Description copied from interface: ThreadedPlugIn

Runs the task. This method will be executed in a separate thread, so that the GUI remains responsive (but only partially so, as a modal progress dialog will be in the way). Don't call GUI classes in this method as it is not executed on the GUI thread.

Parameters:

monitor - context to which this task can report its progress and check whether a party has requested its cancellation