Tag Documentation

Description:

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.

Component Information
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`

Attributes
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: _none [any_other_value]
`defaultFocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of control to focus initially Valid values are: _first _none [any_other_value]
`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: [any_other_value] Effect.Fade Effect.BlindUp Effect.SlideUp Effect.Shrink Effect.Puff Effect.SwitchOff Effect.DropOut Effect.Squish Effect.Fold Effect.CAF.Fade Effect.CAF.SlideClose Effect.CAF.SlideClose.Left Effect.CAF.SlideClose.Top Effect.CAF.SlideClose.Right Effect.CAF.SlideClose.Bottom
`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: [any_other_value] Effect.Appear Effect.BlindDown Effect.SlideDown Effect.Grow Effect.CAF.Appear Effect.CAF.SlideOpen Effect.CAF.SlideOpen.Left Effect.CAF.SlideOpen.Top Effect.CAF.SlideOpen.Right Effect.CAF.SlideOpen.Bottom
`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: portlet-font portlet-font-dim portlet-msg-status portlet-msg-info portlet-msg-error portlet-msg-alert portlet-msg-success portlet-section-header portlet-section-body portlet-section-alternate portlet-section-selected portlet-section-subheader portlet-section-footer portlet-section-text portlet-form-label portlet-form-input-field portlet-form-button portlet-icon-label portlet-dlg-icon-label portlet-form-field-label portlet-form-field portlet-menu portlet-menu-item portlet-menu-item-selected portlet-menu-item-hover portlet-menu-item-hover-selected portlet-menu-cascade-item portlet-menu-cascade-item-selected portlet-menu-description portlet-menu-caption [any_other_value]
`suppressInputs`	`false`	`javax.el.ValueExpression` (must evaluate to `java.util.Collection`)	Ids of controls on which to disallow update processing while handling asynchronous requests If 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".

Overlay Panel - caf_h:panelOverlay