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

Class BooleanEditor

java.lang.Object

org.esa.snap.core.param.AbstractParamEditor

org.esa.snap.core.param.editors.BooleanEditor

All Implemented Interfaces:

ParamEditor, ParamExceptionHandler

public class BooleanEditor
extends AbstractParamEditor

An editor which uses a JCheckBox.

Constructor Summary

Constructors

Constructor	Description
BooleanEditor(Parameter parameter)

Method Summary

Modifier and Type	Method	Description
JCheckBox	getCheckBox()
JComponent	getEditorComponent()	Gets the UI component used to edit the parameter's value.
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, 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 Details

BooleanEditor

public BooleanEditor(Parameter parameter)

Method Details

getCheckBox

public JCheckBox getCheckBox()

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

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