Package adams.gui.goe

Class EventReferenceEditor

java.lang.Object

java.beans.PropertyEditorSupport

adams.gui.goe.AbstractPropertyEditorSupport

adams.gui.goe.EventReferenceEditor

All Implemented Interfaces:

HelpProvider, CustomStringRepresentationHandler, PropertyEditor

Direct Known Subclasses:

TriggerableEventReferenceEditor

public class EventReferenceEditor
extends AbstractPropertyEditorSupport
implements CustomStringRepresentationHandler

A PropertyEditor for EventReference objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseTextField	m_TextValue	The text field with the value.
protected EventsTree	m_Tree	The tree displaying all the events.

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

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 void	discardInput()	Discards the input and closes the dialog.
protected List<String>	findEvents()	Locates all the events for the node.
Object	fromCustomStringRepresentation(String str)	Returns an object created from the custom string representation.
String	getJavaInitializationString()	Returns a representation of the current property value as java source.
protected String	getStringToPaint()	Returns the string to paint.
protected void	initForDisplay()	Initializes the display of the value.
protected boolean	isUnchanged(String s)	Checks whether the string is the same as the currently used one.
protected boolean	isValid(String s)	Checks whether the string is valid.
protected boolean	isValidNode(Node node)	Checks whether the node is valid and can be added to the tree.
void	paintValue(Graphics gfx, Rectangle box)	Paints a representation of the current Object.
protected EventReference	parse(String s)	Parses the given string and returns the generated object.
String	toCustomStringRepresentation(Object obj)	Returns a custom string representation of the object.
protected boolean	updateValue(TreePath path)	Updates the value of the text field if possble, using the last component on the given tree path.

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_TextValue

protected BaseTextField m_TextValue

The text field with the value.

m_Tree

protected EventsTree m_Tree

The tree displaying all the events.

Constructor Detail

EventReferenceEditor

public EventReferenceEditor()

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'

getStringToPaint

protected String getStringToPaint()

Returns the string to paint.

Returns:

the string

See Also:

paintValue(Graphics, Rectangle)

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

See Also:

getStringToPaint()

parse

protected EventReference parse(String s)

Parses the given string and returns the generated object. The string has to be a valid one, i.e., the isValid(String) check has been performed already and succeeded.

Parameters:

s - the string to parse

Returns:

the generated object, or null in case of an error

updateValue

protected boolean updateValue(TreePath path)

Updates the value of the text field if possble, using the last component on the given tree path.

Parameters:

path - the path to use for updating the value

Returns:

true if the text field got updated

createCustomEditor

protected JComponent createCustomEditor()

Gets the custom editor component.

Specified by:

createCustomEditor in class AbstractPropertyEditorSupport

Returns:

the editor

isValid

protected boolean isValid(String s)

Checks whether the string is valid.

Parameters:

s - the string to check

Returns:

true if the string is valid

isUnchanged

protected boolean isUnchanged(String s)

Checks whether the string is the same as the currently used one.

Parameters:

s - the string to check

Returns:

true if the strings are the same

acceptInput

protected void acceptInput()

Accepts the input and closes the dialog.

discardInput

protected void discardInput()

Discards the input and closes the dialog.

isValidNode

protected boolean isValidNode(Node node)

Checks whether the node is valid and can be added to the tree.

Default implementation returns always true.

Parameters:

node - the node to check

Returns:

true if valid

findEvents

protected List<String> findEvents()

Locates all the events for the node.

Returns:

the located events (including Events nodes)

initForDisplay

protected void initForDisplay()

Initializes the display of the value.

Overrides:

initForDisplay in class AbstractPropertyEditorSupport