Package adams.gui.goe

Class VariableNameValuePairEditor

java.lang.Object

java.beans.PropertyEditorSupport

adams.gui.goe.AbstractPropertyEditorSupport

adams.gui.goe.BaseObjectEditor

adams.gui.goe.VariableNameValuePairEditor

All Implemented Interfaces:

HelpProvider, CustomStringRepresentationHandler, InlineEditorSupport, InlineEditorSupportWithFavorites, MultiSelectionEditor, PropertyEditor

public class VariableNameValuePairEditor
extends BaseObjectEditor
implements MultiSelectionEditor

Editor specifically designed for entering variable name/value pairs.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_DefaultBackground	the default background color of the panel.
protected ParameterPanel	m_PanelPair	the panel with name/value.
protected JTextComponent	m_TextName	The text field with the key.

Fields inherited from class adams.gui.goe.BaseObjectEditor

m_ButtonHelp, m_TextValue

Fields inherited from class adams.gui.goe.AbstractPropertyEditorSupport

APPROVE_OPTION, CANCEL_OPTION, EMPTY, m_ChosenOption, m_CustomEditor, m_WindowAdapter, NULL

Constructor Summary

Constructors

Constructor	Description
VariableNameValuePairEditor()

Method Summary

Modifier and Type	Method	Description
protected void	acceptInput()	Accepts the input and closes the dialog.
protected JComponent	createCustomEditor()	Gets the custom editor component.
protected String	currentValue()
Object	fromCustomStringRepresentation(String str)	Returns an object created from the custom string representation.
Object[]	getSelectedObjects(Container parent)	Returns the selected objects.
protected String	getStringToPaint()	Returns the string to paint.
protected void	indicateValidity()	Updates the color of the border, indicating with RED if the input is invalid.
protected void	initForDisplay()	Initializes the display of the value.
String	toCustomStringRepresentation(Object obj)	Returns a custom string representation of the object.

Methods inherited from class adams.gui.goe.BaseObjectEditor

discardInput, getHelpDescription, getInlineFavoritesClass, getInlineValue, getJavaInitializationString, isInlineEditingAvailable, isInlineFavoritesEnabled, isInlineValueValid, isUnchanged, isValid, paintValue, parse, setInlineValue

Methods inherited from class adams.gui.goe.AbstractPropertyEditorSupport

addWindowAdapter, cleanUp, closeDialog, createPopup, createTipText, createWindowAdapter, getChosenOption, getCustomEditor, getHelpIcon, getHelpTitle, getHelpURL, getParentDialog, getParentFrame, initialize, isPaintable, resetChosenOption, setValue, supportsCustomEditor

Methods inherited from class java.beans.PropertyEditorSupport

addPropertyChangeListener, firePropertyChange, getAsText, getSource, getTags, getValue, removePropertyChangeListener, setAsText, setSource

Methods inherited from class java.lang.Object

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

Field Detail

m_TextName

protected JTextComponent m_TextName

The text field with the key.

m_PanelPair

protected ParameterPanel m_PanelPair

the panel with name/value.

m_DefaultBackground

protected Color m_DefaultBackground

the default background color of the panel.

Constructor Detail

VariableNameValuePairEditor

public VariableNameValuePairEditor()

Method Detail

currentValue

protected String currentValue()

acceptInput

protected void acceptInput()

Accepts the input and closes the dialog.

Overrides:

acceptInput in class BaseObjectEditor

createCustomEditor

protected JComponent createCustomEditor()

Gets the custom editor component.

Overrides:

createCustomEditor in class BaseObjectEditor

Returns:

the editor

indicateValidity

protected void indicateValidity()

Updates the color of the border, indicating with RED if the input is invalid.

initForDisplay

protected void initForDisplay()

Initializes the display of the value.

Overrides:

initForDisplay in class BaseObjectEditor

getStringToPaint

protected String getStringToPaint()

Returns the string to paint.

Overrides:

getStringToPaint in class BaseObjectEditor

Returns:

the string

See Also:

BaseObjectEditor.paintValue(Graphics, Rectangle)

toCustomStringRepresentation

public String toCustomStringRepresentation(Object obj)

Returns a custom string representation of the object.

Specified by:

toCustomStringRepresentation in interface CustomStringRepresentationHandler

Overrides:

toCustomStringRepresentation in class BaseObjectEditor

Parameters:

obj - the object to turn into a string

Returns:

the string representation

fromCustomStringRepresentation

public Object fromCustomStringRepresentation(String str)

Returns an object created from the custom string representation.

Specified by:

fromCustomStringRepresentation in interface CustomStringRepresentationHandler

Overrides:

fromCustomStringRepresentation in class BaseObjectEditor

Parameters:

str - the string to turn into an object

Returns:

the object

getSelectedObjects

public Object[] getSelectedObjects(Container parent)

Returns the selected objects.

Specified by:

getSelectedObjects in interface MultiSelectionEditor

Overrides:

getSelectedObjects in class BaseObjectEditor

Parameters:

parent - the parent container

Returns:

the objects