org.tentackle.swing

Interface FormContainer

All Superinterfaces:

FormChangeable

All Known Subinterfaces:

FormWindow

All Known Implementing Classes:

FormCalendar, FormCalendarDialog, FormCalendarField, FormComponentPanel, FormDialog, FormError, FormFieldComponentPanel, FormFileChooser, FormFrame, FormInfo, FormMailField, FormPanel, FormQuestion, FormSpinField, FormTelnoDialog, FormTelnoField, FormUrlField, HourSpinField, MinSecSpinField, MonthSpinField, SearchTextDialog, WorkerDialog, YearSpinField, YesNoRadioButton

public interface FormContainer
extends FormChangeable

Tentackle GUI-containers must implement this interface.

FormContainers are aware of the data binding and provide some more features like online help.

Author:

harald

Method Summary

Modifier and Type	Method and Description
boolean	areValuesChanged() Checks whether the contents of some components in this or sub containers have changed since the last saveValues().
FormComponentBinder	getBinder() Gets the binder of this container.
void	getFormValues() Retrieves the values from all components in this container and all sub containers. Used to update the data from the view according to the data binding.
String	getHelpURL() Gets the online-help URL.
Window	getParentWindow() Gets the parent window.
String	getTitle() Gets the container's title.
void	invalidateParentInfo() Invalidates all container-relevant (cached) information for the hierarchy of this container's parents. For optimization purposes.
boolean	isAutoUpdate() Returns whether the auto-update feature is enabled.
boolean	isBindable() Determines whether this container is bindable.
boolean	isTriggerValuesChangedEnabled() Determines whether triggering value changes is enabled.
void	saveValues() Sets a savepoint for all components in this container and all sub containers.
void	setAutoUpdate(boolean autoUpdate) Sets the auto-update feature for all components in this container and all sub containers.
void	setBindable(boolean bindable) Sets whether this container is bindable, i.e.
void	setFormValues() Sets the values in all form components in this container and all sub containers. Used to update the view from the data according to the data binding.
void	setFormValuesKeepChanged() Sets the values in all unchanged form components in this container and all sub containers. All changed components are left untouched.
void	setHelpURL(String helpURL) Sets the online-help URL. If a help url is set for this container, a browser will be launched to show that url if there is no help url for the component the help was requested for.
void	setTitle(String title) set the (optional) title. If the container is a window, the title is the window-title.
void	setTriggerValuesChangedEnabled(boolean enabled) Enables triggering value changes. Disabling this feature may be necessary for model-agnostic containers.
void	showHelp() Displays online help for this container.
void	triggerValuesChanged() Signals that values in the components of the container may have changed.

Methods inherited from interface org.tentackle.swing.FormChangeable

isChangeable, isHonourChangeable, setChangeable, setHonourChangeable

Method Detail

setTitle

void setTitle(String title)

set the (optional) title.
If the container is a window, the title is the window-title. If the container is a panel, the title is "internal", i.e. may be used by the application to trigger setting the window title, for example.

Parameters:

title - the container's title, null if none

getTitle

String getTitle()

Gets the container's title.

Returns:

the container's title, null if none

setFormValues

void setFormValues()

Sets the values in all form components in this container and all sub containers.
Used to update the view from the data according to the data binding.

getFormValues

void getFormValues()

Retrieves the values from all components in this container and all sub containers.
Used to update the data from the view according to the data binding.

setFormValuesKeepChanged

void setFormValuesKeepChanged()

Sets the values in all unchanged form components in this container and all sub containers.
All changed components are left untouched.

See Also:

FormComponent.isValueChanged()

saveValues

void saveValues()

Sets a savepoint for all components in this container and all sub containers.

See Also:

FormComponent.saveValue()

areValuesChanged

boolean areValuesChanged()

Checks whether the contents of some components in this or sub containers have changed since the last saveValues().

Notice that only components with (FormComponent.isTriggerValueChangedEnabled() == true) will be checked.

Returns:

true if changed

triggerValuesChanged

void triggerValuesChanged()

Signals that values in the components of the container may have changed. The container typically uses that to invoke areValuesChanged() and enabling/disabling a button (e.g. "save", see PdoEditDialog).

setTriggerValuesChangedEnabled

void setTriggerValuesChangedEnabled(boolean enabled)

Enables triggering value changes.
Disabling this feature may be necessary for model-agnostic containers.

Parameters:

enabled - true if invoke triggerValuesChanged() on each change (default), false if not.

isTriggerValuesChangedEnabled

boolean isTriggerValuesChangedEnabled()

Determines whether triggering value changes is enabled.

Returns:

true if invoke triggerValuesChanged() on each change (default), false if not.

setAutoUpdate

void setAutoUpdate(boolean autoUpdate)

Sets the auto-update feature for all components in this container and all sub containers.

Parameters:

autoUpdate - true if auto update the data (default), false if not

See Also:

FormComponent.setAutoUpdate(boolean)

isAutoUpdate

boolean isAutoUpdate()

Returns whether the auto-update feature is enabled.

Returns:

true if auto update the data (default), false if not

See Also:

FormComponent.isAutoUpdate()

getParentWindow

Window getParentWindow()

Gets the parent window.

Returns:

the parent window, null if none

invalidateParentInfo

void invalidateParentInfo()

Invalidates all container-relevant (cached) information for the hierarchy of this container's parents.
For optimization purposes.

setHelpURL

void setHelpURL(String helpURL)

Sets the online-help URL.
If a help url is set for this container, a browser will be launched to show that url if there is no help url for the component the help was requested for.

Parameters:

helpURL - the help url

See Also:

FormUtilities.openHelpURL(Component)

getHelpURL

String getHelpURL()

Gets the online-help URL.

Returns:

the help url, default is null

showHelp

void showHelp()

Displays online help for this container.

getBinder

FormComponentBinder getBinder()

Gets the binder of this container.

Returns:

the binder, never null.

setBindable

void setBindable(boolean bindable)

Sets whether this container is bindable, i.e. should be checked within a binding hierarchy.

FormContainers are bindable by default.

Parameters:

bindable - true if bindable, else not eligible for the binding process

isBindable

boolean isBindable()

Determines whether this container is bindable.

Returns:

true if bindable, else not eligible for the binding process