org.tentackle.ui
Interface FormContainer

All Known Subinterfaces:

FormWindow

All Known Implementing Classes:

AboutDialog, AppDbCursorProgressDialog, AppDbObjectDialog, AppDbObjectFieldPanel, AppDbObjectLinkPanel, AppDbObjectNaviDialog, AppDbObjectNaviPanel, AppDbObjectPanel, AppDbObjectSearchDialog, AppDbObjectTablePanel, CancelSaveDiscardDialog, DefaultQbfPanel, FormCalendar, FormCalendarDialog, FormCalendarField, FormComponentPanel, FormDialog, FormError, FormFieldComponentPanel, FormFileChooser, FormFrame, FormInfo, FormMailField, FormPanel, FormQuestion, FormSpinField, FormTelnoDialog, FormTelnoField, FormUrlField, HistoryTableDialog, HistoryTablePanel, HourSpinField, LoginDialog, MinSecSpinField, MonthComboBox, PasswordDialog, QbfPanel, SearchTextDialog, SecurityDialog, TooltipAndErrorPanel, WorkerDialog, YearSpinField, YesNoRadioButton

public interface FormContainer

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

boolean	areValuesChanged() Checks whether the contents of some components in this or sub containers have changed since the last savepoint.
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	isAllChangeable() Returns whether this container has the all-changeable attribute set.
boolean	isHonourAllChangeable() Returns whether the container should honour the allChangeable attribute.
void	saveValues() Sets a savepoint for all components in this container and all sub containers.
void	setAllChangeable(boolean allChangeable) Sets the changeable attribute of all components of this container and all sub containers.
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	setHonourAllChangeable(boolean honourAllChangeable) Sets whether the container should honour the allChangeable attribute.
void	setTitle(String title) set the (optional) title. If the container is a window, the title is the window-title.
void	showHelp() Displays online help for this container.
void	triggerValuesChanged() Signals that values in the components of the container may have changed.

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

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

setAllChangeable

void setAllChangeable(boolean allChangeable)

Sets the changeable attribute of all components of this container and all sub containers.

Parameters:

allChangeable - true if all changeable (default)

isAllChangeable

boolean isAllChangeable()

Returns whether this container has the all-changeable attribute set.

Returns:

true if all changeable (default)

setHonourAllChangeable

void setHonourAllChangeable(boolean honourAllChangeable)

Sets whether the container should honour the allChangeable attribute.

Parameters:

honourAllChangeable - true to honour allchangeable (default)

isHonourAllChangeable

boolean isHonourAllChangeable()

Returns whether the container should honour the allChangeable attribute.

Returns:

true if honour allchangeable (default)

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:

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