Package adams.gui.goe

Class BaseAnnotationEditor

java.lang.Object

java.beans.PropertyEditorSupport

adams.gui.goe.AbstractPropertyEditorSupport

adams.gui.goe.BaseAnnotationEditor

All Implemented Interfaces:

HelpProvider, CustomStringRepresentationHandler, InlineEditorSupport, PropertyEditor

public class BaseAnnotationEditor
extends AbstractPropertyEditorSupport
implements CustomStringRepresentationHandler, InlineEditorSupport

A PropertyEditor for BaseAnnotation objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

BaseAnnotation

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseCheckBox	m_CheckLineWrap	The checkbox for the line wrap.
protected TextAreaComponent	m_TextValue	The text area 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
BaseAnnotationEditor()

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	getHelpDescription()	Returns a long help description, e.g., used in tiptexts.
String	getInlineValue()	Returns the current value.
String	getJavaInitializationString()	Returns a representation of the current property value as java source.
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.
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, 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 TextAreaComponent m_TextValue

The text area with the value.

m_CheckLineWrap

protected BaseCheckBox m_CheckLineWrap

The checkbox for the line wrap.

Constructor Detail

BaseAnnotationEditor

public BaseAnnotationEditor()

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'

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

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

isInlineEditingAvailable

public boolean isInlineEditingAvailable()

Checks whether inline editing is available.

Specified by:

isInlineEditingAvailable in interface InlineEditorSupport

Returns:

always true

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:

always true

getHelpDescription

public String getHelpDescription()

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

Specified by:

getHelpDescription in interface HelpProvider

Overrides:

getHelpDescription in class AbstractPropertyEditorSupport

Returns:

the help text, null if not available