Package adams.gui.goe

Class AbstractSimpleScriptEditorWithTemplates

java.lang.Object

java.beans.PropertyEditorSupport

adams.gui.goe.AbstractPropertyEditorSupport

adams.gui.goe.AbstractSimpleScriptEditor

adams.gui.goe.AbstractSimpleScriptEditorWithTemplates

All Implemented Interfaces:

HelpProvider, CustomStringRepresentationHandler, InlineEditorSupport, PropertyEditor

public abstract class AbstractSimpleScriptEditorWithTemplates
extends AbstractSimpleScriptEditor

Ancestor for script editors that support text templates.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILENAME	the name of the props file.
protected static Properties	m_Properties	the general properties.

Fields inherited from class adams.gui.goe.AbstractSimpleScriptEditor

m_TextStatement

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

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalMenuItems(JPopupMenu menu)	Hook-method to add further menu items to the menu of the "..." button.
protected abstract String	getKey()	Returns the key in the props file to retrieve.
static Properties	getProperties()	Returns the properties that define the editor.
protected String[]	getTemplates()	Returns the templates to display.
protected String	loadTemplate(String name)	Loads the template.

Methods inherited from class adams.gui.goe.AbstractSimpleScriptEditor

createCustomEditor, createPopupMenu, fromCustomStringRepresentation, getDefaultSize, getInlineValue, getJavaInitializationString, initForDisplay, isInlineEditingAvailable, isInlineValueValid, paintValue, setInlineValue, toCustomStringRepresentation

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

FILENAME

public static final String FILENAME

the name of the props file.

See Also:

Constant Field Values

m_Properties

protected static Properties m_Properties

the general properties.

Constructor Detail

AbstractSimpleScriptEditorWithTemplates

public AbstractSimpleScriptEditorWithTemplates()

Method Detail

getKey

protected abstract String getKey()

Returns the key in the props file to retrieve.

Returns:

the key

getTemplates

protected String[] getTemplates()

Returns the templates to display.

Returns:

the template file names

loadTemplate

protected String loadTemplate(String name)

Loads the template.

Parameters:

name - the resource name

Returns:

the template content, null in case of error

addAdditionalMenuItems

protected void addAdditionalMenuItems(JPopupMenu menu)

Hook-method to add further menu items to the menu of the "..." button.

Adds the templates, if any to the menu.

Overrides:

addAdditionalMenuItems in class AbstractSimpleScriptEditor

Parameters:

menu - the popup menu for the button

getProperties

public static Properties getProperties()

Returns the properties that define the editor.

Returns:

the properties