Package org.esa.snap.core.param
Interface ParamEditor
-
- All Known Implementing Classes:
AbstractParamEditor
,AbstractParamXEditor
,BooleanEditor
,ColorEditor
,ComboBoxEditor
,FileEditor
,LabelEditor
,ListEditor
,RadioButtonEditor
,TextFieldEditor
,TextFieldXEditor
public interface ParamEditor
AParamEditor
provides a UI component which is used to modify the value of a parameter.- Version:
- $Revision$ $Date$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JComponent
getComponent()
Gets the component used in the GUI.JComponent
getEditorComponent()
Gets the component used to edit the parameter's value.ParamExceptionHandler
getExceptionHandler()
Returns an optional exception handler for this editor.JLabel
getLabelComponent()
Gets the label component.Parameter
getParameter()
Gets the parameter to which this editor belongs to.JLabel
getPhysUnitLabelComponent()
Gets the physical unit label component.boolean
isEnabled()
Checks whether or not the editor is enabled,void
reconfigureUI()
Tells the UI to reconfigure itself, since the parameter's properties have changed.void
setEnabled(boolean enabled)
Enables/disables this editor.void
setLabelComponent(JLabel label)
Sets the label component.void
setPhysUnitLabelComponent(JLabel label)
Sets the physical unit component.void
updateUI()
Tells the UI to update it's state.
-
-
-
Method Detail
-
getParameter
Parameter getParameter()
Gets the parameter to which this editor belongs to.
-
getLabelComponent
JLabel getLabelComponent()
Gets the label component.
-
setLabelComponent
void setLabelComponent(JLabel label)
Sets the label component.
-
getPhysUnitLabelComponent
JLabel getPhysUnitLabelComponent()
Gets the physical unit label component.
-
setPhysUnitLabelComponent
void setPhysUnitLabelComponent(JLabel label)
Sets the physical unit component.
-
getEditorComponent
JComponent getEditorComponent()
Gets the component used to edit the parameter's value.- Returns:
- the UI editor component
-
getComponent
JComponent getComponent()
Gets the component used in the GUI. This component is not necessarily the same as the one returned by thegetEditorComponent()
method. For example, the editor component could be aJTextArea
, whereas the actual component used in the GUI is aJScrollPane
which decorates the text area field. In most cases this method will simply return the editor component.- Returns:
- the editor component or the editor component wrapped
- See Also:
getEditorComponent()
-
isEnabled
boolean isEnabled()
Checks whether or not the editor is enabled,
-
setEnabled
void setEnabled(boolean enabled)
Enables/disables this editor.
-
updateUI
void updateUI()
Tells the UI to update it's state.
-
reconfigureUI
void reconfigureUI()
Tells the UI to reconfigure itself, since the parameter's properties have changed.
-
getExceptionHandler
ParamExceptionHandler getExceptionHandler()
Returns an optional exception handler for this editor.
-
-