Package adams.gui.goe

Class FieldEditor

java.lang.Object

java.beans.PropertyEditorSupport

adams.gui.goe.AbstractPropertyEditorSupport

adams.gui.goe.FieldEditor

All Implemented Interfaces:

HelpProvider, CustomStringRepresentationHandler, InlineEditorSupport, MultiSelectionEditor, PropertyEditor

Direct Known Subclasses:

PrefixFieldEditor, SuffixFieldEditor

public class FieldEditor
extends AbstractPropertyEditorSupport
implements CustomStringRepresentationHandler, MultiSelectionEditor, InlineEditorSupport

A PropertyEditor for Field objects that lets the user select a field.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Field

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseButton	m_ButtonClose	the close button.
protected BaseButton	m_ButtonOK	the OK button.
protected SelectFieldPanel	m_SelectFieldPanel	The panel used for selecting fields.

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

Method Summary

Modifier and Type	Method	Description
protected JComponent	createCustomEditor()	Gets the custom editor component.
Object	fromCustomStringRepresentation(String str)	Returns an object created from the custom string representation.
String	getInlineValue()	Returns the current value.
String	getJavaInitializationString()	Returns a representation of the current property value as java source.
Object[]	getSelectedObjects(Container parent)	Returns the selected objects.
protected void	initForDisplay()	Initializes the display of the value.
boolean	isInlineEditingAvailable()	Checks whether inline editing is available.
boolean	isInlineValueValid(String value)	Checks whether the value id valid.
protected AbstractField[]	newArray(List<String> fields, DataType type)	Creates a new array of field objects from the strings.
void	paintValue(Graphics gfx, Rectangle box)	Paints a representation of the current Object.
void	setInlineValue(String value)	Sets the value to use.
String	toCustomStringRepresentation(Object obj)	Returns a custom string representation of the object.

Methods inherited from class adams.gui.goe.AbstractPropertyEditorSupport

addWindowAdapter, cleanUp, closeDialog, createPopup, createTipText, createWindowAdapter, getChosenOption, getCustomEditor, getHelpDescription, 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_SelectFieldPanel

protected SelectFieldPanel m_SelectFieldPanel

The panel used for selecting fields.

m_ButtonOK

protected BaseButton m_ButtonOK

the OK button.

m_ButtonClose

protected BaseButton m_ButtonClose

the close button.

Constructor Detail

FieldEditor

public FieldEditor()

Method Detail

toCustomStringRepresentation

public String toCustomStringRepresentation(Object obj)

Returns a custom string representation of the object.

Specified by:

toCustomStringRepresentation in interface CustomStringRepresentationHandler

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

Parameters:

str - the string to turn into an object

Returns:

the object

getJavaInitializationString

public String getJavaInitializationString()

Returns a representation of the current property value as java source.

Specified by:

getJavaInitializationString in interface PropertyEditor

Overrides:

getJavaInitializationString in class PropertyEditorSupport

Returns:

a value of type 'String'

createCustomEditor

protected JComponent createCustomEditor()

Gets the custom editor component.

Specified by:

createCustomEditor in class AbstractPropertyEditorSupport

Returns:

the editor

initForDisplay

protected void initForDisplay()

Initializes the display of the value.

Overrides:

initForDisplay in class AbstractPropertyEditorSupport

paintValue

public void paintValue(Graphics gfx,
                       Rectangle box)

Paints a representation of the current Object.

Specified by:

paintValue in interface PropertyEditor

Overrides:

paintValue in class PropertyEditorSupport

Parameters:

gfx - the graphics context to use

box - the area we are allowed to paint into

isInlineEditingAvailable

public boolean isInlineEditingAvailable()

Checks whether inline editing is available.

Specified by:

isInlineEditingAvailable in interface InlineEditorSupport

Returns:

true if editing available

setInlineValue

public void setInlineValue(String value)

Sets the value to use.

Specified by:

setInlineValue in interface InlineEditorSupport

Parameters:

value - the value to use

getInlineValue

public String getInlineValue()

Returns the current value.

Specified by:

getInlineValue in interface InlineEditorSupport

Returns:

the current value

isInlineValueValid

public boolean isInlineValueValid(String value)

Checks whether the value id valid.

Specified by:

isInlineValueValid in interface InlineEditorSupport

Parameters:

value - the value to check

Returns:

true if valid

newArray

protected AbstractField[] newArray(List<String> fields,
                                   DataType type)

Creates a new array of field objects from the strings.

Parameters:

fields - the field names to use

type - the type of the fields

Returns:

the field array

getSelectedObjects

public Object[] getSelectedObjects(Container parent)

Returns the selected objects.

Specified by:

getSelectedObjects in interface MultiSelectionEditor

Parameters:

parent - the parent container

Returns:

the objects