By default, only the content area of a tab is refreshed when a modal dialog is submitted. When a modal dialog is closed/cancelled, i.e. no action is performed, the content area is not refreshed.
The tab-refresh element allows different aspects of a tab to be refreshed. The tab actions menu, tab navigation and context panel can all be refreshed based on two events. The first is when a specific UIM page is loaded in the content area and the second when a UIM page is submitted from a modal or the content area.
Refreshing the tab actions menu results in updating the entries in the menu that can be dynamically disabled or hidden. For more information on dynamic support in the tab actions menu see Dynamic Support.
Refreshing the tab navigation results in updating the entries in the tab navigation bar and page group navigation bar that can be dynamically disabled or hidden. For more information on dynamic support in tab navigation see Dynamic Support.
Refreshing the context panel simply reloads the UIM page displayed in the context panel.
Refreshing the content area reloads the UIM page displayed in the content area. This refresh option is available for use only where a modal dialog has been opened from the list dropdown panel of a nested expandable list.
By default only the parent of list dropdown panel is updated when the modal dialog is submitted. Where the list dropdown panel exists in a nested expandable list, this will result in the parent list reloading and not the entire content area.
Under some circumstances, the entire content area may require updating and this option can be used to achieve this for this specific scenario.
The two different type of refresh events can be configured using the child elements detailed in Table 1.
| Element | Description |
|---|---|
| onload | 1..n.
Defines a refresh event, where when the specified page is loaded in the content area, the defined parts of the tab are updated. |
| onsubmit | 1..n.
Defines a refresh event, where when the specified page is submitted from a modal or in the content area, the defined parts of the tab are updated. |
The onsubmit and onload elements both require the same set of attributes, as described in Table 2.
| Attribute | Description |
|---|---|
| page-id | Mandatory.
A reference to the UIM page to associate with the refresh event. |
| context | Optional.
Boolean indicating if the context panel should be update when the specified page is loaded or submitted. |
| menu-bar | Optional.
Boolean indicating if the tab actions menu should be updated when the specified page is loaded or submitted. See Dynamic Support for more information. |
| navigation | Optional.
Boolean indicating if the tab navigation should be updated when the specified page is loaded or submitted. See Dynamic Support for more information. |
| main-content | Optional.
Boolean indicating if the main content area should be updated when the specified page is loaded or submitted. This type of refresh event must only be used for modal dialogs that are opened from a list dropdown panel in a nested expandable list. |