dialog (VDL Documentation Generator - Generated Documentation)

Description:

Dialog is a panel component overlaying other elements. Dialog avoids popup blockers, provides customization, resizing, modality, ajax interactions and more.

Component Information
Info	Value
Component Type	`org.primefaces.component.Dialog`
Handler Class	None
Renderer Type	`org.primefaces.component.DialogRenderer`
Description	None

Attributes
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.
`header`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text of the header.
`draggable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies draggability. Default is true.
`resizable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies resizability. Default is true.
`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.
`blockScroll`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Whether to block scrolling of the document when dialog is modal.
`visible`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Sets dialogs visibility. Default is false.
`width`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Width of the dialog in pixels. Default is auto.
`height`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Height of the dialog.
`minWidth`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Minimum width of a resizable dialog. Default is unl.
`minHeight`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Minimum height of a resizable dialog. Default is height of titlebar.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Inline style of the dialog container.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style class of the dialog container.
`showEffect`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Effect to use when showing the dialog.
`hideEffect`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Effect to use when hiding the dialog.
`my`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Position of the dialog relative to the target. Default is "center".
`position`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines where the dialog should be displayed. Default is "center".
`closable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines if close icon should be displayed or not.
`onShow`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when dialog is displayed.
`onHide`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when dialog is hidden.
`appendTo`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Appends the dialog to the given search expression.
`showHeader`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies visibility of header content.
`footer`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text of the footer.
`dynamic`	`false`	`javax.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.
`minimizable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies if dialog is minimizable or not. Default false.
`maximizable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies if dialog is maximizable or not. Default false.
`closeOnEscape`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines if dialog should close when escape key is pressed. Default is false.
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines text direction, valid values are "ltr" (default) and "rtl".
`focus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines which component to focus.
`fitViewport`	`false`	`javax.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.
`positionType`	`false`	`javax.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.
`responsive`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	In responsive mode, dialog adjusts itself based on screen width.

primefaces-p

Tag dialog