org.esa.beam.framework.processor.ui
Class ParameterPage

java.lang.Object
  org.esa.beam.framework.processor.ui.ParameterPage

Direct Known Subclasses:

IOParameterPage, ProcessingParameterPage, PropertyFileParameterPage

Deprecated. since BEAM 4.11. Use the Graph Processing Framework instead.

@Deprecated
public abstract class ParameterPage
extends Object

This class serves as the base implementation of all derived parameter pages, which can be used in the MultiPageProcessorUI.

Note: Developers should derive ProcessingParameterPage and overwrite addParameterToPanel() for their own UI implementation instead of deriving from this class.

Author:

Marco Peters, Ralf Quast, Norman Fomferra

Constructor Summary

protected

ParameterPage(ParamGroup paramGroup) Deprecated. Creates a new instance of this class.

Method Summary

abstract JComponent	createUI() Deprecated. It creates the UI by using the parameter group of this page.
ProcessorApp	getApp() Deprecated. Gets the processor application associated with this parameter page.
ParamGroup	getParamGroup() Deprecated. Gets the parameter group of this page.
String	getTitle() Deprecated. Gets the title of this page.
abstract void	initRequestFromUI(Request request) Deprecated. Fills the given request with parameters.
void	setApp(ProcessorApp app) Deprecated. Sets the processor app for the UI.
void	setTitle(String title) Deprecated. Sets the title of this page.
void	setUIDefaults() Deprecated. Sets the UI to default values.
abstract void	setUIFromRequest(Request request) Deprecated. Sets the parameter values by these given with the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterPage

protected ParameterPage(ParamGroup paramGroup)

Deprecated.

Creates a new instance of this class.

Parameters:

paramGroup - the parameter group an which the UI is build

Method Detail

setApp

public void setApp(ProcessorApp app)

Deprecated.

Sets the processor app for the UI.

Parameters:

app - the processor application

getApp

public ProcessorApp getApp()

Deprecated.

Gets the processor application associated with this parameter page.

Returns:

the processor application

getTitle

public String getTitle()

Deprecated.

Gets the title of this page. The title is used in the MultiPageProcessorUI as tab title.

Returns:

the title

setTitle

public void setTitle(String title)

Deprecated.

Sets the title of this page. The title is used in the MultiPageProcessorUI as tab title.

Parameters:

title - the title of this page

getParamGroup

public ParamGroup getParamGroup()

Deprecated.

Gets the parameter group of this page.

Returns:

the parameter group.

setUIDefaults

public void setUIDefaults()

Deprecated.

Sets the UI to default values.
It is called by the MultiPageProcessorUI.setDefaultRequests().

createUI

public abstract JComponent createUI()

Deprecated.

It creates the UI by using the parameter group of this page.

It's only called once by the MultiPageProcessorUI during lifetime of an instance of this class.

Returns:

the UI component displayed as page of the MultiPageProcessorUI.

initRequestFromUI

public abstract void initRequestFromUI(Request request)
                                throws ProcessorException

Deprecated.

Fills the given request with parameters.

Parameters:

request - the request to fill

Throws:

ProcessorException - if an error occurred

setUIFromRequest

public abstract void setUIFromRequest(Request request)
                               throws ProcessorException

Deprecated.

Sets the parameter values by these given with the request.

Parameters:

request - the request to obtain the parameters

Throws:

ProcessorException - if an error occurred