| Info | Value |
|---|---|
| Component Type | org.primefaces.component.OverlayPanel |
| Handler Class | None |
| Renderer Type | org.primefaces.component.OverlayPanelRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.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. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
for | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Identifier of the target component to show the panel. |
blockScroll | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to block scrolling of the document when panel is modal. |
showEvent | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Event to show the overlay panel, default is "click". |
hideEvent | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Event to hide the overlay panel, default is "click". |
showEffect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to display when showing the panel. |
hideEffect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to display when hiding the panel. |
appendTo | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Alternative to appendToBody. Appends the overlayPanel to the given search expression. |
onShow | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when panel is displayed. |
onHide | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when panel is hidden. |
my | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the panel relative to the target. |
at | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the target relative to the panel. |
dynamic | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Dynamic mode allows overlay panel to fetch it's contents before it's shown rather than on page load which is useful to reduce initial page load times. Default is false. |
dismissable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, clicking outside of the panel hides the overlay. |
showCloseIcon | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays a close icon to hide the overlay, default is false. |
modal | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value that specifies whether the document should be shielded with a partially transparent mask to require the user to close the Panel before being able to activate any elements in the document. Default is false. |
showDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay time to show overlay panel in milliseconds. Default is 0. |
Output generated by Vdldoc View Declaration Language Documentation Generator.