org.scijava.module.event
Class ModuleCanceledEvent

java.lang.Object
  org.scijava.AbstractContextual
      org.scijava.event.SciJavaEvent
          org.scijava.module.event.ModuleEvent
              org.scijava.module.event.ModuleExecutionEvent
                  org.scijava.module.event.ModuleCanceledEvent

All Implemented Interfaces:

Contextual

public class ModuleCanceledEvent
extends ModuleExecutionEvent

An event indicating a Module execution has been canceled.

Cancelation can occur due to a ModulePreprocessor, such as an InputHarvester when the user presses the Cancel button, or due to the module itself implementing the Cancelable interface and then declaring itself canceled (via the Cancelable.isCanceled() method returning true) after its Runnable.run() method returns.

Author:

Curtis Rueden

Constructor Summary

ModuleCanceledEvent(Module module)

ModuleCanceledEvent(Module module, String reason)

Method Summary

String

getReason()

Methods inherited from class org.scijava.module.event.ModuleEvent

getModule, toString

Methods inherited from class org.scijava.event.SciJavaEvent

consume, getCallingThread, getStackTrace, isConsumed, setCallingThread, setConsumed

Methods inherited from class org.scijava.AbstractContextual

context, getContext, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleCanceledEvent

public ModuleCanceledEvent(Module module)

ModuleCanceledEvent

public ModuleCanceledEvent(Module module,
                           String reason)

Method Detail

getReason

public String getReason()