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.
| Attributes |
| Name |
Required |
Type |
Description |
| autosized |
false |
boolean |
If "true" popupPanel will be auto-sized according to the content. Default value is "false". |
| binding |
false |
javax.faces.component.UIComponent |
The value binding expression used to wire up this component to a component property of a JavaBean class |
| controlsClass |
false |
java.lang.String |
Assigns one or more space-separated CSS class names to the component controls |
| domElementAttachment |
false |
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 |
boolean |
Defines whenever the popup will follow the scrolling of the screen. Default value is "true". |
| header |
false |
java.lang.String |
Assigns the header for the popupPanel. |
| headerClass |
false |
java.lang.String |
Assigns one or more space-separated CSS class names to the component header |
| height |
false |
int |
Attribute defines height of component. Default value is "300". |
| id |
false |
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 |
java.lang.String |
Attribute defines X position of component left-top corner. Default value is "auto". |
| maxHeight |
false |
int |
Attribute defines max height of component. |
| maxWidth |
false |
int |
Attribute defines max width of component. |
| minHeight |
false |
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 |
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 |
boolean |
If "true", popupPanel will be modal - it will block the main screen from any operation. |
| moveable |
false |
boolean |
If "true" there is possibility to move component. Default value is "true". |
| onbeforehide |
false |
java.lang.String |
The client-side code executed before the popup disappears. |
| onbeforeshow |
false |
java.lang.String |
The client-side code executed before this component is shown. |
| onhide |
false |
java.lang.String |
The client-side code executed after the popup disappears. |
| onmaskclick |
false |
java.lang.String |
Javascript code executed when a pointer button is clicked over the popupPanel mask. |
| onmaskcontextmenu |
false |
java.lang.String |
Javascript code executed when a pointer button for context menu is clicked over the popupPanel mask. |
| onmaskdblclick |
false |
java.lang.String |
Javascript code executed when a pointer button is double clicked over the popupPanel mask. |
| onmaskmousedown |
false |
java.lang.String |
Javascript code executed when a pointer button is pressed down over the popupPanel mask. |
| onmaskmousemove |
false |
java.lang.String |
Javascript code executed when a pointer button is moved within the popupPanel mask. |
| onmaskmouseout |
false |
java.lang.String |
Javascript code executed when a pointer button is moved away from the popupPanel mask. |
| onmaskmouseover |
false |
java.lang.String |
Javascript code executed when a pointer button is moved onto the popupPanel mask. |
| onmaskmouseup |
false |
java.lang.String |
Javascript code executed when a pointer button is released over the popupPanel mask. |
| onmove |
false |
java.lang.String |
The client-side script method to be called before the modal panel is moved |
| onresize |
false |
java.lang.String |
The client-side script method to be called when the modal panel is resized |
| onshow |
false |
java.lang.String |
The client-side code executed after the popup is shown. |
| overlapEmbedObjects |
false |
boolean |
If "true" popupPanel creates iframe to overlap embed objects like PDF on a page. Default value is "false". |
| rendered |
false |
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 |
boolean |
If "true" there is possibility to change component size. Default value is "true". |
| shadowDepth |
false |
java.lang.String |
Pop-up shadow depth for suggestion content |
| shadowOpacity |
false |
java.lang.String |
HTML CSS class attribute of element for pop-up suggestion content |
| show |
false |
boolean |
If "true" value for this attribute makes a modal panel opened as default. Default value is "false" |
| style |
false |
java.lang.String |
CSS style(s) to be applied when this component is rendered. |
| styleClass |
false |
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 |
java.lang.String |
Attribute defines Y position of component left-top corner. Default value is "auto". |
| trimOverlayedElements |
false |
boolean |
Defines whether to trim or not elements inside popupPanel. Default value is "true" |
| width |
false |
int |
Attribute defines width of component. Default value is "200". |
| zindex |
false |
int |
Attribute is similar to the standard HTML attribute and can specify window placement relative to the content. Default value
is "3".
|