| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Dialog |
| Handler Class | None |
| Renderer Type | org.primefaces.component.DialogRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
appendTo | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Appends the dialog to the given search expression. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
blockScroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to block scrolling of the document when dialog is modal. |
cache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Only relevant for dynamic="true": Defines if activating the dialog should load the contents from server again. For cache="true" (default) the dialog content is only loaded once. |
closable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if close icon should be displayed or not. |
closeOnEscape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if dialog should close when escape key is pressed. Default is false. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines text direction, valid values are "ltr" (default) and "rtl". |
draggable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies draggability. Default is true. |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Dynamic mode allows dialog 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. |
fitViewport | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Dialog size might exceeed viewport if content is bigger than viewport in terms of height. fitViewport option automatically adjusts height to fit dialog within the viewport. |
focus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines which component to focus. |
footer | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Text of the footer. |
header | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Text of the header. |
height | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Height of the dialog. |
hideEffect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to use when hiding the dialog. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
maximizable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies if dialog is maximizable or not. Default false. |
minHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minimum height of a resizable dialog. Default is height of titlebar. |
minimizable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies if dialog is minimizable or not. Default false. |
minWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minimum width of a resizable dialog. Default is unl. |
modal | false | jakarta.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. |
my | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the dialog relative to the target. Default is "center". |
onHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when dialog is hidden. |
onShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when dialog is displayed. |
position | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines where the dialog should be displayed. Default is "center". |
positionType | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines whether dialog will be kept in viewport on scroll (fixed) or keep its position (absolute). Default is fixed. |
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. |
resizable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies resizability. Default is true. |
responsive | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In responsive mode, dialog adjusts itself based on screen width. |
showEffect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to use when showing the dialog. |
showHeader | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies visibility of header content. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the dialog container. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the dialog container. |
visible | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Sets dialogs visibility. Default is false. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
width | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Width of the dialog in pixels. Default is auto. |
Output generated by Vdldoc View Declaration Language Documentation Generator.