A panel that lays on top of another panel or the entire page when toggled visible using client-side JavaScript. For more information, see the topics "Concealable Controls" and "Toggle Controls" in the CAF Development Help.
Children
Any.
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.panel.OverlayPanel |
Handler Class | None |
Renderer Type | com.webmethods.caf.faces.panel.OverlayPanel |
Description | Hideable panel that overlays another control when toggled visible |
Palette Location | CAF Html/Control/Panel/Overlay Panel |
Client-Side Model | CAF.OverlayPanel.Model |
Name | Required | Type | Description |
---|---|---|---|
centered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if content centered within panel
If not specified, the default value is "true". |
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". |
for | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| ID of control to overlay |
hideEffect | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Name of custom script.aculo.us hide effect
Valid values are:
|
hideEffectOptions | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Additional options for custom script.aculo.us hide effect |
id | false | java.lang.String | Control identifier |
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". |
opacity | false | javax.el.ValueExpression
(must evaluate to java.lang.Double )
| Opacity of panel when visible, from 0.0 (completely transparent) to 1.0 (completely opaque) |
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". |
showEffect | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Name of custom script.aculo.us show effect
Valid values are:
|
showEffectOptions | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Additional options for custom script.aculo.us show effect |
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". |
Output generated by Vdldoc View Declaration Language Documentation Generator.