org.esa.beam.framework.processor.ui
Interface ProcessorUI

All Known Implementing Classes:

AbstractProcessorUI, MultiPageProcessorUI

public interface ProcessorUI

This interface defines the basic operations any processor user interface has to provide to interact with the processor framework.

Clients should use the AbstractProcessorUI as base class for their implementations, because the ProcessorUI interface may change in the future.

Method Summary

JComponent	getGuiComponent() Retrieves the base component for the processor specific user interface classes.
Vector	getRequests() Retrieves the list of requests currently edited.
void	setApp(ProcessorApp app) Sets the processor application context.
void	setDefaultRequests() Create a set of new default requests.
void	setRequests(Vector requests) Sets a new Request to be edited.

Method Detail

getGuiComponent

JComponent getGuiComponent()

Retrieves the base component for the processor specific user interface classes. This can be any Java Swing containertype.

getRequests

Vector getRequests()
                   throws ProcessorException

Retrieves the list of requests currently edited.

Throws:

ProcessorException

setRequests

void setRequests(Vector requests)
                 throws ProcessorException

Sets a new Request to be edited.

Throws:

ProcessorException

setDefaultRequests

void setDefaultRequests()
                        throws ProcessorException

Create a set of new default requests.

Throws:

ProcessorException

setApp

void setApp(ProcessorApp app)

Sets the processor application context.

This method is called only once during the lifetime of a UI and immediately called after creation in the createUI() method of the processor.

In most cases the implementations of this method will simply store the processor application context for later use and possibly add a RequestValidator to it.

See Also:

ProcessorApp.addRequestValidator(org.esa.beam.framework.processor.RequestValidator), ProcessorApp.markIODirChanges(org.esa.beam.framework.param.ParamGroup)