A control that encapsulates the style and behavior of a modal dialog. A modal dialog forces the user to choose an option in the dialog, usually by clicking a button, before the user can do anything outside of the dialog. Compare to a Modeless Dialog control where the user can perform actions outside the dialog before interacting with the Modeless Dialog control.
The Modal Dialog control is initially hidden. When toggled visible, the Modal dialog disables all other controls on the page until it is changed to hidden.
Like other hideable controls, this control can be toggled between visible and hidden through client-side JavaScript code. Toggle controls encapsulate this code within controls that can be created and configured visually within CAF. For more information, see the topics "Hideable Controls" and "Toggle Controls" in the section "User Interface Controls Concepts" in the webMethods CAF Development Help.
This control has four facets: title, submit, cancel, and other. The last three facets encapsulate the default layout for the submit, cancel, and various other buttons. For example, if you place a cancel button in the cancel facet, and an OK button in the submit facet, by default the modal dialog places the cancel button in the bottom-right corner of the dialog, with the OK button directly to its left. The title facet displays a title for the dialog.
Children
Any. Children of this control are displayed as the dialog's content.
| Info | Value |
|---|---|
| Component Type | com.webmethods.caf.faces.panel.ModalDialog |
| Handler Class | None |
| Renderer Type | com.webmethods.caf.faces.panel.ModalDialog |
| Description | Dialog which user must interact with immediately when displayed |
| Palette Location | CAF Html/Control/Dialog/Modal Dialog |
| Client-Side Model | CAF.Dialog.Modal.Model |
| Name | Description |
|---|---|
title | Dialog title |
submit | Dialog submit button |
cancel | Dialog cancel button |
other | Dialog other buttons |
| Name | Required | Type | Description |
|---|---|---|---|
defaultCommand | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
Id of default command control
Valid values are:
|
defaultFocus | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
Id of control to focus initially
Valid values are:
|
disableWhenHidden | false | javax.el.ValueExpression
(must evaluate to boolean)
|
Disables input controls when panel is hidden, preventing the input controls from submitting
If not specified, the default value is "false". |
forTarget | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Target for Modal Dialog to be displayed next to |
id | false | java.lang.String | Control identifier |
isMoveable | false | javax.el.ValueExpression
(must evaluate to boolean)
| Whether this Dialog can be moved by the user |
lazy | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if panel loads content asynchronously on demand
If not specified, the default value is "false". |
offsetx | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Horizontal offset of panel |
offsety | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Vertical offset of panel |
position | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
Position of modal dialog relative to 'target for' control
Valid values are:
|
progressDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
|
Milliseconds to wait before showing progress dialog
If not specified, the default value is "0". |
progressFlashOnComplete | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if panel should flash when asynchronous loading has completed
If not specified, the default value is "true". |
progressMsg | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Progress dialog message; defaults to a localized message, in English "Loading..." |
progressUseHideShowEffect | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if progress dialog should use panel's hide and show effects; false if progress dialog shouldn't use default effects
If not specified, the default value is "false". |
refreshOnShow | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to refresh content every time panel is toggled visible. Ignored if Lazy Load is false.
If not specified, the default value is "false". |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to render control; false to ignore it
If not specified, the default value is "true". |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML "style" attribute value |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
HTML "class" attribute value
Valid values are:
|
suppressInputs | false | javax.el.ValueExpression
(must evaluate to java.util.Collection)
|
WARNING: This property has been deprecated. Ids of controls on which to disallow update processing while handling asynchronous requestsIf not specified, the default value is "false". |
twoPass | false | javax.el.ValueExpression
(must evaluate to boolean)
|
Render initial content asynchronously. Ignored if Lazy Load is false.
If not specified, the default value is "false". |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Width in pixels (i.e. 100px) or percent (i.e. 100%) |
Output generated by Vdldoc View Declaration Language Documentation Generator.