dsto.dfc.swing.forms
Class AbstractFormEditor

java.lang.Object
  dsto.dfc.swing.forms.BasicFormEditorEventSource
      dsto.dfc.swing.forms.AbstractFormEditor

All Implemented Interfaces:

FormEditor, Copyable, Serializable, Cloneable

Direct Known Subclasses:

CellToFormEditorAdapter, FormEditorValueAdapter, JCheckBoxFormEditor, JComboBoxFormEditor, JLabelFormEditor, JListFormEditor, JListSelectionFormEditor, JSliderFormEditor, JTableFormEditor, JTextFieldFormEditor, NumericSpinnerFormEditor, StyleSheetTableView.FormEditorAdapter

public abstract class AbstractFormEditor
extends BasicFormEditorEventSource
implements FormEditor

Utility base class for FormEditor's.

Version:

$Revision$

See Also:

Serialized Form

Field Summary

protected ValueConverter	converter
protected String	description

Constructor Summary

AbstractFormEditor()

AbstractFormEditor(String description, ValueConverter converter)

AbstractFormEditor(ValueConverter converter)

Method Summary

abstract void	commitEdits() Commit any changes not already committed into the value of this editor (eg a text editor will attempt to perform any uncommitted text conversions at this point).
abstract Component	getEditorComponent() Get the component, if any, that acts as a UI for this editor.
String	getEditorDescription() Get a short description of the value being edited for this editor (eg 'host name').
abstract Object	getEditorValue() Get the current value from the form editor.
Class	getPreferredValueType() Default implementation: returns java.lang.Object to indicate no preferred type.
abstract boolean	isDirectEdit() True if the editor directly edits the value passed in with setValue ().
void	setEditorDescription(String newValue)
abstract void	setEditorValue(Object value) Sets the value to be displayed/edited by the form editor.

Methods inherited from class dsto.dfc.swing.forms.BasicFormEditorEventSource

addFormEditorListener, clone, fireEditComitted, fireEditCommitRequested, fireEditCommitted, removeFormEditorListener, setFormEditorEventSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface dsto.dfc.swing.forms.FormEditor

addFormEditorListener, removeFormEditorListener

Field Detail

converter

protected ValueConverter converter

description

protected String description

Constructor Detail

AbstractFormEditor

public AbstractFormEditor()

AbstractFormEditor

public AbstractFormEditor(ValueConverter converter)

AbstractFormEditor

public AbstractFormEditor(String description,
                          ValueConverter converter)

Method Detail

getEditorDescription

public String getEditorDescription()

Description copied from interface: FormEditor

Get a short description of the value being edited for this editor (eg 'host name'). May be null.

Specified by:

getEditorDescription in interface FormEditor

setEditorDescription

public void setEditorDescription(String newValue)

getPreferredValueType

public Class getPreferredValueType()

Default implementation: returns java.lang.Object to indicate no preferred type.

Specified by:

getPreferredValueType in interface FormEditor

isDirectEdit

public abstract boolean isDirectEdit()

Description copied from interface: FormEditor

True if the editor directly edits the value passed in with setValue (). If false, the parent editor will be reponsible for retrieving the value from the editor and storing it.

Specified by:

isDirectEdit in interface FormEditor

setEditorValue

public abstract void setEditorValue(Object value)
                             throws IllegalFormatException

Description copied from interface: FormEditor

Sets the value to be displayed/edited by the form editor.

Specified by:

setEditorValue in interface FormEditor

Parameters:

value - The value to display.

Throws:

IllegalFormatException - if the value was not in the correct format for display by this editor. The source specified by the exception should be this FormEditor instance or a child.

getEditorValue

public abstract Object getEditorValue()

Description copied from interface: FormEditor

Get the current value from the form editor. At least one call to setValue () must be made beforehand.

Specified by:

getEditorValue in interface FormEditor

getEditorComponent

public abstract Component getEditorComponent()

Description copied from interface: FormEditor

Get the component, if any, that acts as a UI for this editor. May return null if not associated with a component.

Specified by:

getEditorComponent in interface FormEditor

commitEdits

public abstract void commitEdits()
                          throws IllegalFormatException

Description copied from interface: FormEditor

Commit any changes not already committed into the value of this editor (eg a text editor will attempt to perform any uncommitted text conversions at this point). Only editors that need support editing in non-atomic sessions (such as text fields) will generally do anything when this method is called. If commit is made that has not been signalled with a previous editCommitted event, the editor should fire an editCommitted event at this point. Composite editors, such as forms, will generally forward this request to their child editors.

Specified by:

commitEdits in interface FormEditor

Throws:

IllegalFormatException - if the commit failed because of an illegal input or other error. The source specified by the exception should be the FormEditor instance that caused the error (ie either this editor or a child).