Package org.esa.snap.core.param.editors

Class TextFieldEditor

java.lang.Object

org.esa.snap.core.param.AbstractParamEditor

org.esa.snap.core.param.editors.TextFieldEditor

All Implemented Interfaces:

ParamEditor, ParamExceptionHandler

public class TextFieldEditor
extends AbstractParamEditor

An editor which uses a JTextField or JTextArea.

Constructor Summary

Constructors

Constructor	Description
TextFieldEditor(Parameter parameter)

Method Summary

Modifier and Type	Method	Description
JComponent	getComponent()	Gets a JTextField componet or a JTextArea wrapped with e.g.
JComponent	getEditorComponent()	Gets the UI component used to edit the parameter's value.
JTextComponent	getTextComponent()
protected void	initUI()	Initialized the UI of this editor.
void	updateUI()	Tells the UI to update it's state.

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

checkParameterValue, 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

TextFieldEditor

public TextFieldEditor(Parameter parameter)

Method Detail

getTextComponent

public JTextComponent getTextComponent()

getEditorComponent

public JComponent getEditorComponent()

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

Returns:

the UI editor component

getComponent

public JComponent getComponent()

Gets a JTextField componet or a JTextArea wrapped with e.g. a JScrollPane.

Specified by:

getComponent in interface ParamEditor

Overrides:

getComponent in class AbstractParamEditor

Returns:

a JTextField componet or a JTextArea wrapped with e.g. a JScrollPane.

See Also:

getEditorComponent()

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()

Description copied from class: AbstractParamEditor

Tells the UI to update it's state. The default implementations en-/disables the label components (if any) of this editor.

Note: If you override this method, you should call this base class version first.

Specified by:

updateUI in interface ParamEditor

Overrides:

updateUI in class AbstractParamEditor