Package org.scijava.widget

Class AbstractInputHarvester<P,W>

java.lang.Object

org.scijava.AbstractContextual

org.scijava.widget.AbstractInputHarvester<P,W>

Type Parameters:

P - The type of UI component housing the input panel itself.

W - The type of UI component housing each input widget.

All Implemented Interfaces:

Contextual, InputHarvester<P,W>

Direct Known Subclasses:

AbstractInputHarvesterPlugin

public abstract class AbstractInputHarvester<P,W>
extends AbstractContextual
implements InputHarvester<P,W>

Abstract superclass for InputHarvesters.

An input harvester obtains a module's unresolved input parameter values from the user. Parameters are collected using an InputPanel dialog box.

Author:

Curtis Rueden

Field Summary

Fields inherited from interface org.scijava.widget.InputHarvester

PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractInputHarvester()

Method Summary

Modifier and Type	Method	Description
void	buildPanel(InputPanel<P,W> inputPanel, Module module)	Populates the given InputPanel with widgets corresponding to the given Module instance.

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

setContext

Methods inherited from interface org.scijava.widget.InputHarvester

createInputPanel, harvest, harvestInputs, processResults

Constructor Detail

AbstractInputHarvester

public AbstractInputHarvester()

Method Detail

buildPanel

public void buildPanel(InputPanel<P,W> inputPanel,
                       Module module)
                throws ModuleException

Description copied from interface: InputHarvester

Populates the given InputPanel with widgets corresponding to the given Module instance.

Specified by:

buildPanel in interface InputHarvester<P,W>

Parameters:

inputPanel - The panel to populate.

module - The module whose inputs should be translated into widgets.

Throws:

ModuleException - if the panel cannot be populated for some reason. This may occur due to an input of unsupported type.