org.scohen.juploadr.prefs
Interface ConfigurationForm

All Known Implementing Classes:

BaseConfigurationForm, UploadActionForm

public interface ConfigurationForm

A Control for viewing and editing a sub-set of config settings. Each ConfigurationForm implementation is responsible for validating and persisting any changes made. This generic interface is intended to simplify the addition of new types of preferences, for example with plugins.

In addition to the methods in the interface, the contract of ConfigurationForm includes two additional requirements:

• All implementations must be sub-classes of org.eclipse.swt.widgets.Control. (Typically they will satisfy this requirement by extending org.eclipse.swt.widgets.Composite or org.eclipse.swt.widgets.Canvas.)
• All implementations must provide a one-argument constructor which takes as its only argument a parent org.eclipse.swt.widgets.Composite, which it is expected will be used only to pass through to the super-class constructor.

Author:

John

Method Summary

void	accountChanged()
java.lang.String	getFormName() Get a short name for the preferences this form class provides access to.
void	saveChanges() Save any changes made using the form.
void	setConfigurationDialog(ConfigurationDialog dialog)
Fault	validateChanges() Validate any changes made, returning an array of user-friendly error messages if there is a problem.

Method Detail

saveChanges

public void saveChanges()

Save any changes made using the form. If the form internally tracks whether changes have been made, this call may be a no-op.

validateChanges

public Fault validateChanges()

Validate any changes made, returning an array of user-friendly error messages if there is a problem. If validation passes, then returns null or an empty array.

Returns:

getFormName

public java.lang.String getFormName()

Get a short name for the preferences this form class provides access to.

Returns:

a short name for the preferences this form provides access to.

setConfigurationDialog

public void setConfigurationDialog(ConfigurationDialog dialog)

accountChanged

public void accountChanged()