The Modal Section is a container control that displays modally. I.E. you cannot continue on the main window until it is dismissed.
Different from the Modal Alert control, a Modal Section is not an alert, it serves more as a separate section from the main interface for the user to handle a tangent task or display something, which precludes the user from working on other parts of the UI. Typically a layout of other control(s) (e.g. Well or Panel) is used inside of a Modal Section.
Like almost all SPARK controls, you can trigger events that are fired when the user interacts with the control (see the Event and Methods sections below and the Event Handling article for more information).
This control is most commonly used when needing to alert the user about something important and not allowing them to continue until they close the Modal Section window.
Behavior
Close on Click If this is checked, you can close the modal section outside of the modal section (gray area). Note: When the user clicks on the grey area, the Modal Section gets dismissed.
Example
When the user clicks the "Available Vacation Balance" button, the Modal Section is set to visible with the setVisible method...
When the page loads...
When the "Available Vacation Balance" button is clicked...
Note: You have to set the Visibility to 'None' at first or it will show by default.
Events
With the Modal Section, there are 2 types of event handlers:
- On Load When the page loads
- On Close When the Modal Section window is closed
You can use JavaScript logic to affect the effects of the control, depending on the event. More information on using these controls can be found in the Event Handling article.
Methods
For detailed information on the available methods for this control, access the JS Doc file.
Related Article(s)
- Author: Courtney Silva
- Date Created: June 24, 2015
- Date Modified: August 31, 2015
Comments