dsto.dfc.swing.forms
Interface Form

All Superinterfaces:

FormEditor

All Known Implementing Classes:

BasicEnumeratedTermCustomizer, BasicForm, FormDialog, FormPanel, GradientPanel, LogWindowPopperEditor, MultiplexFormEditor

public interface Form
extends FormEditor

Defines a form that acts as a host for FormEditor's.

Version:

$Revision$

Author:

Matthew

Method Summary

void	addEditor(String property, FormEditor editor)
void	addEditor(String property, FormEditor editor, ValueConverter converter) Add an editor for a given property of the form value.
boolean	isDeferredCommit() True if editor commit requests from child editors are deferred until commitEdits () is explicitly called on this form.
boolean	removeEditor(FormEditor editor) Remove a bound form editor.
void	setDeferredCommit(boolean newValue)

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

addFormEditorListener, commitEdits, getEditorComponent, getEditorDescription, getEditorValue, getPreferredValueType, isDirectEdit, removeFormEditorListener, setEditorValue

Method Detail

addEditor

void addEditor(String property,
               FormEditor editor)

addEditor

void addEditor(String property,
               FormEditor editor,
               ValueConverter converter)

Add an editor for a given property of the form value.

Parameters:

property - The property name.

editor - The editor for the property.

converter - The value converter that will be used to convert values into the editor's format (determined by FormEditor.getPreferredValueType() and from the editor back to the property value. May be null for no conversion.

See Also:

removeEditor(dsto.dfc.swing.forms.FormEditor)

removeEditor

boolean removeEditor(FormEditor editor)

Remove a bound form editor.

Returns:

True if the editor was removed.

See Also:

addEditor(java.lang.String, dsto.dfc.swing.forms.FormEditor)

isDeferredCommit

boolean isDeferredCommit()

True if editor commit requests from child editors are deferred until commitEdits () is explicitly called on this form. This can be used to implement forms where the user can apply changes via commitEdits () or cancel edits by simply not calling commitEdits () without having to copy the value being edited by the form. When in deferred commit mode, the form will copy values before passing them to setValue () on "direct edit" child FormEditor's and handle editCommitRequested events from sub-editors by calling commit () but not storing the subeditor's value.

setDeferredCommit

void setDeferredCommit(boolean newValue)