Hook: Define a FormSheet

Requirement

A FormSheet needs to be defined that can be displayed by a SalesPoint or as part of a SaleProcess.

Method of Adaptation

Add Feature

Level of Support

Parameter Pattern

HotSpot

FormSheets

Hooks used

Define an Action

Participants

FormSheet, newFormSheet , fs , FormSheetContentCreator, NewFormSheetContentCreator , JComponent, newComponent , action

Changes

1. subclass NewFormSheetContentCreator of FormSheetContentCreator.
2. NewFormSheetContentCreator.createFormSheetContent overrides FormSheetContentCreator.createFormSheetContent (let fs := FormSheet passed as parameter):
1. instance newComponent of JComponent or subclass.
2. call fs.setComponent with component newComponent.
3. if default " OK " and " Cancel " buttons not wanted:
1. call fs.removeAllButtons .
4. repeat as needed:
1. instance action of Define an Action [NewAction].
2. call fs.addButton with parameters button caption, button id and action.
3. instance newFormSheet of FormSheet with caption and instance of NewFormSheetContentCreator.

Comments

• If the FormSheet does not need to be serializable, you can work without the FormSheetContentCreator and call the appropriate methods directly on the FormSheet. However, when the FormSheet gets serialized, during deserialization only the changes made through content creators will be restored.
• If subclassing a default FormSheet, you can use the same approach, as FormSheetContentCreators build an inheritance hierarchy for each single FormSheet instance. I.e., when creating or deserializing a FormSheet, all FormSheetContentCreators associated to a single FormSheet will be invoked, in the order they were added to the FormSheet.
• If you need only to adapt the behavior of the standard " OK " and " Cancel " button, you can also apply the Change Standard OK/Cancel Button Behavior hook.
• To link actions to buttons in the JComponent part of a FormSheet, invoke the Define Action For Button In Component hook.