OptionsPlugin (SciJava Javadocs 0-SNAPSHOT API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.scijava.module.AbstractModule
- - org.scijava.module.DefaultMutableModule
  - - org.scijava.command.DynamicCommand
    - - org.scijava.options.OptionsPlugin

All Implemented Interfaces:

Runnable, Cancelable, Command, Contextual, Module, MutableModule, SciJavaPlugin, SingletonPlugin

Direct Known Subclasses:

MATLABOptions, OptionsLookAndFeel
```
public abstract class OptionsPlugin
extends DynamicCommand
implements SingletonPlugin
```
Base class for all options-oriented plugins.

Author:

Barry DeZonia, Curtis Rueden

Field Summary

Fields
Modifier and Type Field and Description

protected EventService eventService
- Fields inherited from class org.scijava.command.DynamicCommand
  moduleService, pluginService

Constructor Summary

Constructors
Constructor and Description

OptionsPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Performs necessary cleanup in response to cancellation of the module execution.
`void`	`load()` Loads option values from persistent storage.
`void`	`reset()` Clears option values from persistent storage.
`void`	`run()`
`void`	`save()` Saves option values to persistent storage.

Methods inherited from class org.scijava.command.DynamicCommand
cancel, context, getCancelReason, getContext, getInfo, getInput, getOutput, isCanceled, saveInputs, setContext, setInput, setOutput, uncancel

Methods inherited from class org.scijava.module.AbstractModule
getDelegateObject, getInputs, getOutputs, initialize, isInputResolved, isOutputResolved, preview, resolveInput, resolveOutput, setInputs, setOutputs, unresolveInput, unresolveOutput

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scijava.module.MutableModule
addInput, addInput, addOutput, addOutput, removeInput, removeOutput

Methods inherited from interface org.scijava.module.Module
getDelegateObject, getInputs, getOutputs, initialize, isInputResolved, isOutputResolved, isResolved, preview, resolveInput, resolveOutput, setInputs, setOutputs, setResolved, unresolveInput, unresolveOutput

- Field Detail
  - eventService
```
protected EventService eventService
```
- Constructor Detail
  - OptionsPlugin
```
public OptionsPlugin()
```
- Method Detail
  - load
```
public void load()
```
    Loads option values from persistent storage.
  - save
```
public void save()
```
    Saves option values to persistent storage.
  - reset
```
public void reset()
```
    Clears option values from persistent storage.
  - cancel
```
public void cancel()
```
    Description copied from interface: Module
    
    Performs necessary cleanup in response to cancellation of the module execution. This is useful in conjunction with Module.preview() to undo any changes made as a result of the preview.
    
    Specified by:
    
    cancel in interface Module
    
    Overrides:
    
    cancel in class AbstractModule
    
    See Also:
    
    ModuleInfo.canCancel()
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
    
    Specified by:
    
    run in interface MutableModule

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2022 SciJava. All rights reserved.