Package org.esa.snap.core.param

Class AbstractParamXEditor

java.lang.Object

org.esa.snap.core.param.AbstractParamEditor

org.esa.snap.core.param.AbstractParamXEditor

All Implemented Interfaces:

ParamEditor, ParamExceptionHandler

Direct Known Subclasses:

ColorEditor, TextFieldXEditor

public abstract class AbstractParamXEditor
extends AbstractParamEditor

A AbstractParamXEditor is base class for editors which use special purpose editors for editing a parameter value. For example, the special purpose editor could be a color chooser or file chooser dialog. The special purpose editor is invoked by pressing the "..." button usually located to the right of the value display.

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractParamXEditor(Parameter parameter, boolean useDefaultVerifier)	Creates the object with a given parameter.

Method Summary

Modifier and Type	Method	Description
protected AbstractButton	createXEditorButton()
JComponent	getEditorComponent()	Gets the UI component used to edit the parameter's value.
abstract JComponent	getEditorComponentChild()
protected AbstractButton	getXEditorButton()
protected Icon	getXEditorIcon()	Gets the "standard" edit icon used for parameter editors.
protected String	getXEditorTitle()
protected void	initUI()	Initialized the UI of this editor.
protected abstract void	initUIChild()
protected abstract void	invokeXEditor()
void	updateUI()	Tells the UI to update it's state.

Methods inherited from class org.esa.snap.core.param.AbstractParamEditor

checkParameterValue, getComponent, getDefaultActionListener, getDefaultInputVerifier, getExceptionHandler, getLabelComponent, getParameter, getPhysUnitLabelComponent, handleParamException, isEnabled, nameComponent, nameEditorComponent, nameLabelComponent, nameUnitComponent, reconfigureUI, setDefaultLabelComponent, setDefaultPhysUnitLabelComponent, setEnabled, setLabelComponent, setParameterValue, setPhysUnitLabelComponent

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParamXEditor

protected AbstractParamXEditor(Parameter parameter,
                               boolean useDefaultVerifier)

Creates the object with a given parameter.

Parameters:

parameter - the Parameter to be edited.

useDefaultVerifier - true if a default verifier should be used

Method Detail

getEditorComponent

public JComponent getEditorComponent()

Gets the UI component used to edit the parameter's value.

Returns:

the UI editor component

initUI

protected void initUI()

Description copied from class: AbstractParamEditor

Initialized the UI of this editor. Called only once within this editor's constructor.

The default implementation creates a label component for the parameter's "label" and "physicalUnit" properties.

Overrides:

initUI in class AbstractParamEditor

updateUI

public void updateUI()

Tells the UI to update it's state.

Note: If you override this method, please call the super class version first.

Specified by:

updateUI in interface ParamEditor

Overrides:

updateUI in class AbstractParamEditor

initUIChild

protected abstract void initUIChild()

getEditorComponentChild

public abstract JComponent getEditorComponentChild()

invokeXEditor

protected abstract void invokeXEditor()

getXEditorButton

protected AbstractButton getXEditorButton()

createXEditorButton

protected AbstractButton createXEditorButton()

getXEditorIcon

protected Icon getXEditorIcon()

Gets the "standard" edit icon used for parameter editors.

getXEditorTitle

protected String getXEditorTitle()