| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.BlockUI |
| Handler Class | None |
| Renderer Type | org.primefaces.extensions.component.BlockUIRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
autoShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag whether the blocking is shown automatically without the need to use JavaScript widget. Default value is false. |
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. |
centerX | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Set this attribute to true to have the message automatically centered along the X axis. Note: it only effects element blocking (page blocking controlled by CSS via the css attribute). Default value is true. |
centerY | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Set this attribute to true to have the message automatically centered along the Y axis. Default value is true. |
content | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Id of the component in terms of findComponent to be used as content shown during blocking. If nothing specified, the content of blockUI component is used. |
css | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Styles for the message when blocking. Styles should be defined as JSON object, e.g. {backgroundColor: 'fff', width: 30%}. |
cssOverlay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Styles for the overlay. Styles should be defined as JSON object, e.g. {opacity: 0.4, backgroundColor: 'red'} |
event | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name(s) of one or several accepted events. Several events should be defined as space or comma separated list. |
fadeIn | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Fade In time in millis; set to 0 to disable fadeIn on block. |
fadeOut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Fade Out time in millis; set to 0 to disable fadeOut on unblock. |
focusInput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Focus will be placed in the first available input field when page blocking. Default value is true. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
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. |
showOverlay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disable if you do not want to show the overlay. Default value is true. |
source | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies component(s) which send(s) an ajax request and triggers blocking. If nothing specified, the parent component is used. |
target | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies component(s) or HTML element(s) to be blocked. If the target is null or not defined, the entire page is blocked. |
timeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Time in millis to wait before auto-unblocking. Don't define it or set to 0 to disable auto-unblock. Default value is 0. |
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.