@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIPopupPanel extends AbstractPopupPanel implements javax.faces.component.behavior.ClientBehaviorHolder, EventsPopupsBeforeProps, EventsPopupsProps, PopupsProps, StyleClassProps, StyleProps
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.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIPopupPanel.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Constructor and Description |
---|
UIPopupPanel() |
Modifier and Type | Method and Description |
---|---|
String |
getControlsClass()
Assigns one or more space-separated CSS class names to the component controls
|
String |
getDefaultEventName() |
String |
getDomElementAttachment()
Defines the DOM element, which stacking context will assimilate the popupPanel.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHeader()
Assigns the header for the popupPanel.
|
String |
getHeaderClass()
Assigns one or more space-separated CSS class names to the component header
|
int |
getHeight()
Attribute defines height of component.
|
String |
getLeft()
Attribute defines X position of component left-top corner.
|
int |
getMaxHeight()
Attribute defines max height of component.
|
int |
getMaxWidth()
Attribute defines max width of component.
|
int |
getMinHeight()
Attribute defines min height of component.
|
int |
getMinWidth()
Attribute defines min width of component.
|
String |
getOnbeforehide()
The client-side code executed before the popup disappears.
|
String |
getOnbeforeshow()
The client-side code executed before this component is shown.
|
String |
getOnhide()
The client-side code executed after the popup disappears.
|
String |
getOnmaskclick()
Javascript code executed when a pointer button is clicked over the popupPanel mask.
|
String |
getOnmaskcontextmenu()
Javascript code executed when a pointer button for context menu is clicked over the popupPanel mask.
|
String |
getOnmaskdblclick()
Javascript code executed when a pointer button is double clicked over the popupPanel mask.
|
String |
getOnmaskmousedown()
Javascript code executed when a pointer button is pressed down over the popupPanel mask.
|
String |
getOnmaskmousemove()
Javascript code executed when a pointer button is moved within the popupPanel mask.
|
String |
getOnmaskmouseout()
Javascript code executed when a pointer button is moved away from the popupPanel mask.
|
String |
getOnmaskmouseover()
Javascript code executed when a pointer button is moved onto the popupPanel mask.
|
String |
getOnmaskmouseup()
Javascript code executed when a pointer button is released over the popupPanel mask.
|
String |
getOnmove()
The client-side script method to be called before the modal panel is moved
|
String |
getOnresize()
The client-side script method to be called when the modal panel is resized
|
String |
getOnshow()
The client-side code executed after the popup is shown.
|
String |
getShadowDepth()
Pop-up shadow depth for suggestion content
|
String |
getShadowOpacity()
HTML CSS class attribute of element for pop-up suggestion content
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTop()
Attribute defines Y position of component left-top corner.
|
String |
getVisualOptions()
Defines options that were specified on the client side
|
int |
getWidth()
Attribute defines width of component.
|
int |
getZindex()
Attribute is similar to the standard HTML attribute and can specify window placement relative to the content.
|
boolean |
isAutosized()
If "true" popupPanel will be auto-sized according to the content.
|
boolean |
isFollowByScroll()
Defines whenever the popup will follow the scrolling of the screen.
|
boolean |
isKeepVisualState()
If "true" popupPanel should save state after submission.
|
boolean |
isModal()
If "true", popupPanel will be modal - it will block the main screen from any operation.
|
boolean |
isMoveable()
If "true" there is possibility to move component.
|
boolean |
isOverlapEmbedObjects()
If "true" popupPanel creates iframe to overlap embed objects like PDF on a page.
|
boolean |
isResizeable()
If "true" there is possibility to change component size.
|
boolean |
isShow()
If "true" value for this attribute makes a modal panel opened as default.
|
boolean |
isTrimOverlayedElements()
Defines whether to trim or not elements inside popupPanel.
|
void |
setAutosized(boolean autosized) |
void |
setControlsClass(String controlsClass) |
void |
setDomElementAttachment(String domElementAttachment) |
void |
setFollowByScroll(boolean followByScroll) |
void |
setHeader(String header) |
void |
setHeaderClass(String headerClass) |
void |
setHeight(int height) |
void |
setKeepVisualState(boolean keepVisualState) |
void |
setLeft(String left) |
void |
setMaxHeight(int maxHeight) |
void |
setMaxWidth(int maxWidth) |
void |
setMinHeight(int minHeight) |
void |
setMinWidth(int minWidth) |
void |
setModal(boolean modal) |
void |
setMoveable(boolean moveable) |
void |
setOnbeforehide(String onbeforehide) |
void |
setOnbeforeshow(String onbeforeshow) |
void |
setOnhide(String onhide) |
void |
setOnmaskclick(String onmaskclick) |
void |
setOnmaskcontextmenu(String onmaskcontextmenu) |
void |
setOnmaskdblclick(String onmaskdblclick) |
void |
setOnmaskmousedown(String onmaskmousedown) |
void |
setOnmaskmousemove(String onmaskmousemove) |
void |
setOnmaskmouseout(String onmaskmouseout) |
void |
setOnmaskmouseover(String onmaskmouseover) |
void |
setOnmaskmouseup(String onmaskmouseup) |
void |
setOnmove(String onmove) |
void |
setOnresize(String onresize) |
void |
setOnshow(String onshow) |
void |
setOverlapEmbedObjects(boolean overlapEmbedObjects) |
void |
setResizeable(boolean resizeable) |
void |
setShadowDepth(String shadowDepth) |
void |
setShadowOpacity(String shadowOpacity) |
void |
setShow(boolean show) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTop(String top) |
void |
setTrimOverlayedElements(boolean trimOverlayedElements) |
void |
setVisualOptions(String visualOptions) |
void |
setWidth(int width) |
void |
setZindex(int zindex) |
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class AbstractPopupPanel
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public boolean isAutosized()
AbstractPopupPanel
isAutosized
in class AbstractPopupPanel
public void setAutosized(boolean autosized)
public String getControlsClass()
AbstractPopupPanel
getControlsClass
in class AbstractPopupPanel
public void setControlsClass(String controlsClass)
public String getDomElementAttachment()
AbstractPopupPanel
getDomElementAttachment
in class AbstractPopupPanel
public void setDomElementAttachment(String domElementAttachment)
public boolean isFollowByScroll()
AbstractPopupPanel
isFollowByScroll
in class AbstractPopupPanel
public void setFollowByScroll(boolean followByScroll)
public String getHeader()
AbstractPopupPanel
getHeader
in class AbstractPopupPanel
public void setHeader(String header)
public String getHeaderClass()
AbstractPopupPanel
getHeaderClass
in class AbstractPopupPanel
public void setHeaderClass(String headerClass)
public int getHeight()
AbstractPopupPanel
getHeight
in class AbstractPopupPanel
public void setHeight(int height)
public boolean isKeepVisualState()
AbstractPopupPanel
isKeepVisualState
in class AbstractPopupPanel
public void setKeepVisualState(boolean keepVisualState)
public String getLeft()
AbstractPopupPanel
getLeft
in class AbstractPopupPanel
public void setLeft(String left)
public int getMaxHeight()
AbstractPopupPanel
getMaxHeight
in class AbstractPopupPanel
public void setMaxHeight(int maxHeight)
public int getMaxWidth()
AbstractPopupPanel
getMaxWidth
in class AbstractPopupPanel
public void setMaxWidth(int maxWidth)
public int getMinHeight()
AbstractPopupPanel
getMinHeight
in class AbstractPopupPanel
public void setMinHeight(int minHeight)
public int getMinWidth()
AbstractPopupPanel
getMinWidth
in class AbstractPopupPanel
public void setMinWidth(int minWidth)
public boolean isModal()
AbstractPopupPanel
isModal
in class AbstractPopupPanel
public void setModal(boolean modal)
public boolean isMoveable()
AbstractPopupPanel
isMoveable
in class AbstractPopupPanel
public void setMoveable(boolean moveable)
public String getOnbeforehide()
EventsPopupsBeforeProps
getOnbeforehide
in interface EventsPopupsBeforeProps
public void setOnbeforehide(String onbeforehide)
public String getOnbeforeshow()
EventsPopupsBeforeProps
getOnbeforeshow
in interface EventsPopupsBeforeProps
public void setOnbeforeshow(String onbeforeshow)
public String getOnhide()
EventsPopupsProps
getOnhide
in interface EventsPopupsProps
public void setOnhide(String onhide)
public String getOnmaskclick()
AbstractPopupPanel
getOnmaskclick
in class AbstractPopupPanel
public void setOnmaskclick(String onmaskclick)
public String getOnmaskcontextmenu()
AbstractPopupPanel
getOnmaskcontextmenu
in class AbstractPopupPanel
public void setOnmaskcontextmenu(String onmaskcontextmenu)
public String getOnmaskdblclick()
AbstractPopupPanel
getOnmaskdblclick
in class AbstractPopupPanel
public void setOnmaskdblclick(String onmaskdblclick)
public String getOnmaskmousedown()
AbstractPopupPanel
getOnmaskmousedown
in class AbstractPopupPanel
public void setOnmaskmousedown(String onmaskmousedown)
public String getOnmaskmousemove()
AbstractPopupPanel
getOnmaskmousemove
in class AbstractPopupPanel
public void setOnmaskmousemove(String onmaskmousemove)
public String getOnmaskmouseout()
AbstractPopupPanel
getOnmaskmouseout
in class AbstractPopupPanel
public void setOnmaskmouseout(String onmaskmouseout)
public String getOnmaskmouseover()
AbstractPopupPanel
getOnmaskmouseover
in class AbstractPopupPanel
public void setOnmaskmouseover(String onmaskmouseover)
public String getOnmaskmouseup()
AbstractPopupPanel
getOnmaskmouseup
in class AbstractPopupPanel
public void setOnmaskmouseup(String onmaskmouseup)
public String getOnmove()
AbstractPopupPanel
getOnmove
in class AbstractPopupPanel
public void setOnmove(String onmove)
public String getOnresize()
AbstractPopupPanel
getOnresize
in class AbstractPopupPanel
public void setOnresize(String onresize)
public String getOnshow()
EventsPopupsProps
getOnshow
in interface EventsPopupsProps
public void setOnshow(String onshow)
public boolean isOverlapEmbedObjects()
AbstractPopupPanel
isOverlapEmbedObjects
in class AbstractPopupPanel
public void setOverlapEmbedObjects(boolean overlapEmbedObjects)
public boolean isResizeable()
AbstractPopupPanel
isResizeable
in class AbstractPopupPanel
public void setResizeable(boolean resizeable)
public String getShadowDepth()
AbstractPopupPanel
getShadowDepth
in class AbstractPopupPanel
public void setShadowDepth(String shadowDepth)
public String getShadowOpacity()
AbstractPopupPanel
getShadowOpacity
in class AbstractPopupPanel
public void setShadowOpacity(String shadowOpacity)
public boolean isShow()
AbstractPopupPanel
isShow
in class AbstractPopupPanel
public void setShow(boolean show)
setShow
in class AbstractPopupPanel
public String getStyle()
StyleProps
getStyle
in interface StyleProps
public void setStyle(String style)
public String getStyleClass()
StyleClassProps
getStyleClass
in interface StyleClassProps
public void setStyleClass(String styleClass)
public String getTop()
AbstractPopupPanel
getTop
in class AbstractPopupPanel
public void setTop(String top)
public boolean isTrimOverlayedElements()
AbstractPopupPanel
isTrimOverlayedElements
in class AbstractPopupPanel
public void setTrimOverlayedElements(boolean trimOverlayedElements)
public String getVisualOptions()
AbstractPopupPanel
getVisualOptions
in class AbstractPopupPanel
public void setVisualOptions(String visualOptions)
public int getWidth()
AbstractPopupPanel
getWidth
in class AbstractPopupPanel
public void setWidth(int width)
public int getZindex()
PopupsProps
getZindex
in interface PopupsProps
getZindex
in class AbstractPopupPanel
public void setZindex(int zindex)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.