dsto.dfc.swing.forms
Class FormEditorValueAdapter

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

All Implemented Interfaces:

FormEditor, FormEditorListener, Copyable, Disposable, Serializable, Cloneable, EventListener

public class FormEditorValueAdapter
extends AbstractFormEditor
implements FormEditor, FormEditorListener, Disposable

A form editor that acts as a simple wrapper around any FormEditor instance. Allows a ValueConverter to convert to/from the format used by it's wrapped editor. Note that this type of auto conversion can also be performed by BasicForm's BasicForm.addEditor(java.lang.String,dsto.dfc.swing.forms.FormEditor,dsto.dfc.swing.text.ValueConverter) method.

Version:

$Revision$

See Also:

Serialized Form

Field Summary

Fields inherited from class dsto.dfc.swing.forms.AbstractFormEditor

converter, description

Constructor Summary

FormEditorValueAdapter(FormEditor adaptee, ValueConverter converter)

Method Summary

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).
void	dispose() Dispose of the object (unregister listeners, close open resources etc).
void	editCommitRequested(ChangeEvent e) Signals that the editor is ready to commit a value into the model.
void	editCommitted(ChangeEvent e) Signals that an edit has been committed into the model.
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').
Object	getEditorValue() Get the current value from the form editor.
Class	getPreferredValueType() Default implementation: returns java.lang.Object to indicate no preferred type.
boolean	isDirectEdit() True if the editor directly edits the value passed in with setValue ().
void	setEditorValue(Object value) Sets the value to be displayed/edited by the form editor.

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

setEditorDescription

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

Constructor Detail

FormEditorValueAdapter

public FormEditorValueAdapter(FormEditor adaptee,
                              ValueConverter converter)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Dispose of the object (unregister listeners, close open resources etc). It should be safe to call this method more than once. Note for beans that support client event listeners: if there are listeners registered when this is called, this method should do nothing.

Specified by:

dispose in interface Disposable

isDirectEdit

public 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

Specified by:

isDirectEdit in class AbstractFormEditor

getPreferredValueType

public Class getPreferredValueType()

Description copied from class: AbstractFormEditor

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

Specified by:

getPreferredValueType in interface FormEditor

Overrides:

getPreferredValueType in class AbstractFormEditor

setEditorValue

public 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

Specified by:

setEditorValue in class AbstractFormEditor

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

Specified by:

getEditorValue in class AbstractFormEditor

commitEdits

public 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

Specified by:

commitEdits in class AbstractFormEditor

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).

getEditorComponent

public 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

Specified by:

getEditorComponent in class AbstractFormEditor

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

Overrides:

getEditorDescription in class AbstractFormEditor

editCommitted

public void editCommitted(ChangeEvent e)

Description copied from interface: FormEditorListener

Signals that an edit has been committed into the model.

Specified by:

editCommitted in interface FormEditorListener

editCommitRequested

public void editCommitRequested(ChangeEvent e)

Description copied from interface: FormEditorListener

Signals that the editor is ready to commit a value into the model. Parent editors monitor will invoke commitEdits () on the the requesting editor if appropriate.

Specified by:

editCommitRequested in interface FormEditorListener