Package adams.gui.goe

Class BaseObjectEditor

java.lang.Object

java.beans.PropertyEditorSupport

adams.gui.goe.AbstractPropertyEditorSupport

adams.gui.goe.BaseObjectEditor

All Implemented Interfaces:

HelpProvider, CustomStringRepresentationHandler, InlineEditorSupport, InlineEditorSupportWithFavorites, MultiSelectionEditor, PropertyEditor

Direct Known Subclasses:

BaseIntervalEditor, BaseKeyValuePairEditor, BasePasswordEditor, BaseRegExpEditor, MavenArtifactEditor, MavenArtifactExclusionEditor, MavenRepositoryEditor, VariableNameStorageNamePairEditor, VariableNameValuePairEditor

public class BaseObjectEditor
extends AbstractPropertyEditorSupport
implements CustomStringRepresentationHandler, MultiSelectionEditor, InlineEditorSupportWithFavorites

A PropertyEditor for BaseObject-derived objects.

If the

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

BaseObject

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseButton	m_ButtonHelp	the help button for bringing up a browser with the Java Pattern class.
protected JTextComponent	m_TextValue	The text field with the value.

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

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.
Object	fromCustomStringRepresentation(String str)	Returns an object created from the custom string representation.
String	getHelpDescription()	Returns a long help description, e.g., used in tiptexts.
Class	getInlineFavoritesClass()	Returns the class to use for favorites.
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 String	getStringToPaint()	Returns the string to paint.
protected void	initForDisplay()	Initializes the display of the value.
boolean	isInlineEditingAvailable()	Checks whether inline editing is available.
boolean	isInlineFavoritesEnabled()	Checks whether favorites support is available.
boolean	isInlineValueValid(String value)	Checks whether the value id valid.
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.
void	paintValue(Graphics gfx, Rectangle box)	Paints a representation of the current Object.
protected BaseObject	parse(String s)	Parses the given string and returns the generated 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, 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 JTextComponent m_TextValue

The text field with the value.

m_ButtonHelp

protected BaseButton m_ButtonHelp

the help button for bringing up a browser with the Java Pattern class.

Constructor Detail

BaseObjectEditor

public BaseObjectEditor()

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 BaseObject 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

createCustomEditor

protected JComponent createCustomEditor()

Gets the custom editor component.

Specified by:

createCustomEditor in class AbstractPropertyEditorSupport

Returns:

always null

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.

initForDisplay

protected void initForDisplay()

Initializes the display of the value.

Overrides:

initForDisplay in class AbstractPropertyEditorSupport

getSelectedObjects

public Object[] getSelectedObjects(Container parent)

Returns the selected objects.

Specified by:

getSelectedObjects in interface MultiSelectionEditor

Parameters:

parent - the parent container

Returns:

the objects

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

isInlineFavoritesEnabled

public boolean isInlineFavoritesEnabled()

Checks whether favorites support is available.

Specified by:

isInlineFavoritesEnabled in interface InlineEditorSupportWithFavorites

Returns:

true if enabled

getInlineFavoritesClass

public Class getInlineFavoritesClass()

Returns the class to use for favorites.

Specified by:

getInlineFavoritesClass in interface InlineEditorSupportWithFavorites

Returns:

the class to use

getHelpDescription

public String getHelpDescription()

Returns a long help description, e.g., used in tiptexts.

If current value is an instance of HelpProvider, then its description is returned, otherwise the value's tip text.

Specified by:

getHelpDescription in interface HelpProvider

Overrides:

getHelpDescription in class AbstractPropertyEditorSupport

Returns:

the help text, null if not available