The <rich:popupPanel> component provides a pop-up panel or window that appears in front of the rest of the application. The <rich:popupPanel> component functions either as a modal window which blocks interaction with the rest of the application while active, or as a non-modal window. It can be positioned on the screen, dragged to a new position by the user, and re-sized.
| Info | Value |
|---|---|
| Component Type | org.richfaces.PopupPanel |
| Handler Class | None |
| Renderer Type | org.richfaces.PopupPanelRenderer |
| Description | The <rich:popupPanel> component provides a pop-up panel or window that appears in front of the rest of the application. The <rich:popupPanel> component functions either as a modal window which blocks interaction with the rest of the application while active, or as a non-modal window. It can be positioned on the screen, dragged to a new position by the user, and re-sized. |
| Name | Required | Type | Description |
|---|---|---|---|
autosized |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true" popupPanel will be auto-sized according to the content. Default value is "false". |
binding |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| The value binding expression used to wire up this component to a component property of a JavaBean class |
controlsClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Assigns one or more space-separated CSS class names to the component controls |
domElementAttachment |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the DOM element, which stacking context will assimilate the popupPanel. Possible values: "body", "form", "parent". Default value is "body". |
followByScroll |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Defines whenever the popup will follow the scrolling of the screen. Default value is "true". |
header |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Assigns the header for the popupPanel. |
headerClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Assigns one or more space-separated CSS class names to the component header |
height |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute defines height of component. Default value is "300". |
id |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
left |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Attribute defines X position of component left-top corner. Default value is "auto". |
maxHeight |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute defines max height of component. |
maxWidth |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute defines max width of component. |
minHeight |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute defines min height of component. Default value is "10". If the value is less then 10, a "IllegalArgumentException" exception is thrown. |
minWidth |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute defines min width of component. Default value is "10". If the value is less then 10, a "IllegalArgumentException" exception is thrown. |
modal |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true", popupPanel will be modal - it will block the main screen from any operation. |
moveable |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true" there is possibility to move component. Default value is "true". |
onbeforehide |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side code executed before the popup disappears. |
onbeforeshow |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side code executed before this component is shown. |
onhide |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side code executed after the popup disappears. |
onmaskclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is clicked over the popupPanel mask. |
onmaskcontextmenu |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button for context menu is clicked over the popupPanel mask. |
onmaskdblclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is double clicked over the popupPanel mask. |
onmaskmousedown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is pressed down over the popupPanel mask. |
onmaskmousemove |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved within the popupPanel mask. |
onmaskmouseout |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved away from the popupPanel mask. |
onmaskmouseover |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved onto the popupPanel mask. |
onmaskmouseup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is released over the popupPanel mask. |
onmove |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called before the modal panel is moved |
onresize |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when the modal panel is resized |
onshow |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side code executed after the popup is shown. |
overlapEmbedObjects |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true" popupPanel creates iframe to overlap embed objects like PDF on a page. Default value is "false". |
rendered |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
resizeable |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true" there is possibility to change component size. Default value is "true". |
shadowDepth |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Pop-up shadow depth for suggestion content |
shadowOpacity |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML CSS class attribute of element for pop-up suggestion content |
show |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true" value for this attribute makes a modal panel opened as default. Default value is "false" |
style |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
top |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Attribute defines Y position of component left-top corner. Default value is "auto". |
trimOverlayedElements |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Defines whether to trim or not elements inside popupPanel. Default value is "true" |
width |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute defines width of component. Default value is "200". |
zindex |
false
| javax.el.ValueExpression
(must evaluate to int)
| Attribute is similar to the standard HTML attribute and can specify window placement relative to the content. Default value is "100". |
Output generated by Vdldoc View Declaration Language Documentation Generator.