sale
Interface FormSheetContainer

All Known Implementing Classes:

JDisplayDialog

public interface FormSheetContainer

An object that can contain and display FormSheets. FormSheetContainers are usually also displays. The two interfaces FormSheetContainer and Display are two sides of one coin, with Display being the view of the application developer and FormSheetContainer the framework (i.e. FormSheet) view.

Since:

v2.0

Author:

Steffen Zschaler

Method Summary

void	closeFormSheet(FormSheet fs) Close a FormSheet.
void	onFormSheetButtonAdded(FormSheet fs, FormSheet.FormButton fb) Notification event informing that a button was added to the FormSheet's button bar.
void	onFormSheetButtonRemoved(FormSheet fs, FormSheet.FormButton fb) Notification event informing that a button was removed from the FormSheet's button bar.
void	onFormSheetButtonsCleared(FormSheet fs) Notification event informing that all buttons were removed from a FormSheet's button bar.
void	onFormSheetCaptionChanged(FormSheet fs, String sNewCaption) Notification event informing about a change of a FormSheet's caption.
void	onFormSheetComponentChanged(FormSheet fs, JComponent jcmpNew) Notification event informing about a change of a FormSheet's component.

Method Detail

closeFormSheet

void closeFormSheet(FormSheet fs)

Close a FormSheet.

Closing a FormSheet must hide all the GUI elements that stem from displaying the FormSheet. It must then detach this display from the FormSheet. Any Display.setFormSheet(sale.FormSheet) calls waiting for this FormSheet to be closed, must be unblocked.

Parameters:

fs - the FormSheet to be closed.

Override:

Always

onFormSheetCaptionChanged

void onFormSheetCaptionChanged(FormSheet fs,
                               String sNewCaption)

Notification event informing about a change of a FormSheet's caption.

Parameters:

fs - the FormSheet whose caption changed.

sNewCaption - the new caption of the FormSheet.

Override:

Always

onFormSheetComponentChanged

void onFormSheetComponentChanged(FormSheet fs,
                                 JComponent jcmpNew)

Notification event informing about a change of a FormSheet's component.

Parameters:

fs - the FormSheet whose component changed.

jcmpNew - the new component of the FormSheet.

Override:

Always

onFormSheetButtonAdded

void onFormSheetButtonAdded(FormSheet fs,
                            FormSheet.FormButton fb)

Notification event informing that a button was added to the FormSheet's button bar.

Parameters:

fs - the FormSheet whose button bar changed.

fb - the button that was added to the FormSheet.

Override:

Always

onFormSheetButtonRemoved

void onFormSheetButtonRemoved(FormSheet fs,
                              FormSheet.FormButton fb)

Notification event informing that a button was removed from the FormSheet's button bar.

Parameters:

fs - the FormSheet whose button bar changed.

fb - the button that was removed from the FormSheet.

Override:

Always

onFormSheetButtonsCleared

void onFormSheetButtonsCleared(FormSheet fs)

Notification event informing that all buttons were removed from a FormSheet's button bar.

Parameters:

fs - the FormSheet whose button bar was cleared.

Override:

Always