| Info | Value |
|---|---|
| Component Type | org.primefaces.component.OverlayPanel |
| Handler Class | None |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
appendTo | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component to append overlay panel to. |
at | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the target element.Default is left bottom. |
autoHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, overlay panel automatically hides when clicking outside.Default is true. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
blockScroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, blocks scrolling when overlay panel is shown.Default is false. |
cache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, overlay panel content is cached.Default is true. |
collision | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| When the overlay panel collides with the viewport, it will be repositioned.Default is flip. |
dismissable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, overlay panel can be dismissed by clicking outside of it.Default is true. |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, overlay panel content is loaded dynamically.Default is false. |
for | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Target component to attach overlay panel to. |
hideEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event name to hide the overlay panel.Default is click. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer.Default is generated. |
modal | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, overlay panel is displayed as modal.Default is false. |
my | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the overlay panel relative to the target.Default is left top. |
onHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side callback to execute when overlay panel is hidden. |
onShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side callback to execute when overlay panel is shown. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered.Default is true. |
showCloseIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, displays a close icon.Default is false. |
showDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay in milliseconds before showing the overlay panel.Default is 0. |
showEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event name to show the overlay panel.Default is click. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.