rle.vm
Class Editor

java.lang.Object
  rle.vm.Editor

All Implemented Interfaces:

Saveable

Direct Known Subclasses:

AttributeTypeCombo, CheckBoxEditor, ColorEditor, FormattedTextEditor, KeyCaptureEditor, NodeComboEditor, NumberEditor, ProviderEditor, SwitcherEditor, TextAreaEditor, TextEditor, TileSetComboEditor, TranslatedTextEditor

public abstract class Editor
extends java.lang.Object
implements Saveable

A ui component that edits a particular attribute. These are mapped to attributes within an attribute set using the variant manager. NOTE: It is very important that subclasses not instantiate expensive UI classes (such as JTextField, etc) until initialize() is called; some VariantMgr operations instantiate the Editors simply for behavior oriented tasks, such as validating saved data, and instantiating such classes will have very visible performance implications.

Field Summary

protected AttributeBean	attribute
protected InfoNode	owner
protected java.lang.String	parameters
protected TreeTool	treeTool

Constructor Summary

Editor()

Method Summary

void	applyDefaults(AttributeBean attribute, InfoNode owner, TreeTool treeTool) Enforce any default value that might be appropriate.
AttributeBean	getAttribute()
abstract javax.swing.JComponent	getEditorComponent() Returns the component that forms the UI for this Editor.
InfoNode	getOwner()
java.lang.String	getParameters()
TreeTool	getTreeTool()
void	initialize(AttributeBean attribute, InfoNode owner, TreeTool treeTool) Method called to configure the editor.
protected java.util.Map<java.lang.String,java.lang.String>	paramMap()
protected java.util.Map	paramMap(AttributeBean a)
void	save()
void	setAttribute(AttributeBean attribute)
void	setOwner(InfoNode owner)
void	setParameters(java.lang.String parameters)
void	setTreeTool(TreeTool treeTool)
java.util.List<java.lang.String>	validate(AttributeBean attribute, InfoNode owner, TreeTool treeTool) Analyze the data saved for this attribute and return any validation errors that the user needs to be notified of, or an empty List if there are no such errors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

treeTool

protected TreeTool treeTool

attribute

protected AttributeBean attribute

owner

protected InfoNode owner

parameters

protected java.lang.String parameters

Constructor Detail

Editor

public Editor()

Method Detail

save

public void save()

Specified by:

save in interface Saveable

setTreeTool

public void setTreeTool(TreeTool treeTool)

getTreeTool

public TreeTool getTreeTool()

setAttribute

public void setAttribute(AttributeBean attribute)

getAttribute

public AttributeBean getAttribute()

setOwner

public void setOwner(InfoNode owner)

getOwner

public InfoNode getOwner()

initialize

public void initialize(AttributeBean attribute,
                       InfoNode owner,
                       TreeTool treeTool)

Method called to configure the editor. May be overridden in sub classes to perform any needed layout. This method calls applyDefaults() to allow subclasses to assume that a value exists (if a default is specified).

Parameters:

attribute -

owner -

treeTool -

getEditorComponent

public abstract javax.swing.JComponent getEditorComponent()

Returns the component that forms the UI for this Editor. initialize() must be called before calling this method to create the component.

applyDefaults

public void applyDefaults(AttributeBean attribute,
                          InfoNode owner,
                          TreeTool treeTool)

Enforce any default value that might be appropriate. This method is used by the VariantMgr.refresh() methods to ensure that nodes are given their default values even if the node is never visited in the Variant Manager.

Parameters:

attribute -

owner -

treeTool -

validate

public java.util.List<java.lang.String> validate(AttributeBean attribute,
                                                 InfoNode owner,
                                                 TreeTool treeTool)

Analyze the data saved for this attribute and return any validation errors that the user needs to be notified of, or an empty List if there are no such errors.

Parameters:

attribute -

owner -

treeTool -

setParameters

public void setParameters(java.lang.String parameters)

getParameters

public java.lang.String getParameters()

paramMap

protected java.util.Map<java.lang.String,java.lang.String> paramMap()

paramMap

protected java.util.Map paramMap(AttributeBean a)