|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.AbstractPopupPanel
org.richfaces.component.UIPopupPanel
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIPopupPanel
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.
| Nested Class Summary | |
|---|---|
protected static class |
UIPopupPanel.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class javax.faces.component.UIComponent |
|---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
| Constructor Summary | |
|---|---|
UIPopupPanel()
|
|
| Method Summary | |
|---|---|
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()
|
String |
getOnbeforeshow()
|
String |
getOnhide()
|
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()
|
String |
getShadowDepth()
Pop-up shadow depth for suggestion content |
String |
getShadowOpacity()
HTML CSS class attribute of element for pop-up suggestion content |
String |
getStyle()
|
String |
getStyleClass()
|
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()
|
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)
|
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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 |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
|---|
addClientBehavior, getClientBehaviors |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIPopupPanel()
| Method Detail |
|---|
public String getFamily()
getFamily in class AbstractPopupPanelpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic boolean isAutosized()
AbstractPopupPanel
isAutosized in class AbstractPopupPanelpublic void setAutosized(boolean autosized)
public String getControlsClass()
AbstractPopupPanel
getControlsClass in class AbstractPopupPanelpublic void setControlsClass(String controlsClass)
public String getDomElementAttachment()
AbstractPopupPanel
getDomElementAttachment in class AbstractPopupPanelpublic void setDomElementAttachment(String domElementAttachment)
public boolean isFollowByScroll()
AbstractPopupPanel
isFollowByScroll in class AbstractPopupPanelpublic void setFollowByScroll(boolean followByScroll)
public String getHeader()
AbstractPopupPanel
getHeader in class AbstractPopupPanelpublic void setHeader(String header)
public String getHeaderClass()
AbstractPopupPanel
getHeaderClass in class AbstractPopupPanelpublic void setHeaderClass(String headerClass)
public int getHeight()
AbstractPopupPanel
getHeight in class AbstractPopupPanelpublic void setHeight(int height)
public boolean isKeepVisualState()
AbstractPopupPanel
isKeepVisualState in class AbstractPopupPanelpublic void setKeepVisualState(boolean keepVisualState)
public String getLeft()
AbstractPopupPanel
getLeft in class AbstractPopupPanelpublic void setLeft(String left)
public int getMaxHeight()
AbstractPopupPanel
getMaxHeight in class AbstractPopupPanelpublic void setMaxHeight(int maxHeight)
public int getMaxWidth()
AbstractPopupPanel
getMaxWidth in class AbstractPopupPanelpublic void setMaxWidth(int maxWidth)
public int getMinHeight()
AbstractPopupPanel
getMinHeight in class AbstractPopupPanelpublic void setMinHeight(int minHeight)
public int getMinWidth()
AbstractPopupPanel
getMinWidth in class AbstractPopupPanelpublic void setMinWidth(int minWidth)
public boolean isModal()
AbstractPopupPanel
isModal in class AbstractPopupPanelpublic void setModal(boolean modal)
public boolean isMoveable()
AbstractPopupPanel
isMoveable in class AbstractPopupPanelpublic void setMoveable(boolean moveable)
public String getOnbeforehide()
getOnbeforehide in class AbstractPopupPanelpublic void setOnbeforehide(String onbeforehide)
public String getOnbeforeshow()
getOnbeforeshow in class AbstractPopupPanelpublic void setOnbeforeshow(String onbeforeshow)
public String getOnhide()
getOnhide in class AbstractPopupPanelpublic void setOnhide(String onhide)
public String getOnmaskclick()
AbstractPopupPanel
getOnmaskclick in class AbstractPopupPanelpublic void setOnmaskclick(String onmaskclick)
public String getOnmaskcontextmenu()
AbstractPopupPanel
getOnmaskcontextmenu in class AbstractPopupPanelpublic void setOnmaskcontextmenu(String onmaskcontextmenu)
public String getOnmaskdblclick()
AbstractPopupPanel
getOnmaskdblclick in class AbstractPopupPanelpublic void setOnmaskdblclick(String onmaskdblclick)
public String getOnmaskmousedown()
AbstractPopupPanel
getOnmaskmousedown in class AbstractPopupPanelpublic void setOnmaskmousedown(String onmaskmousedown)
public String getOnmaskmousemove()
AbstractPopupPanel
getOnmaskmousemove in class AbstractPopupPanelpublic void setOnmaskmousemove(String onmaskmousemove)
public String getOnmaskmouseout()
AbstractPopupPanel
getOnmaskmouseout in class AbstractPopupPanelpublic void setOnmaskmouseout(String onmaskmouseout)
public String getOnmaskmouseover()
AbstractPopupPanel
getOnmaskmouseover in class AbstractPopupPanelpublic void setOnmaskmouseover(String onmaskmouseover)
public String getOnmaskmouseup()
AbstractPopupPanel
getOnmaskmouseup in class AbstractPopupPanelpublic void setOnmaskmouseup(String onmaskmouseup)
public String getOnmove()
AbstractPopupPanel
getOnmove in class AbstractPopupPanelpublic void setOnmove(String onmove)
public String getOnresize()
AbstractPopupPanel
getOnresize in class AbstractPopupPanelpublic void setOnresize(String onresize)
public String getOnshow()
getOnshow in class AbstractPopupPanelpublic void setOnshow(String onshow)
public boolean isOverlapEmbedObjects()
AbstractPopupPanel
isOverlapEmbedObjects in class AbstractPopupPanelpublic void setOverlapEmbedObjects(boolean overlapEmbedObjects)
public boolean isResizeable()
AbstractPopupPanel
isResizeable in class AbstractPopupPanelpublic void setResizeable(boolean resizeable)
public String getShadowDepth()
AbstractPopupPanel
getShadowDepth in class AbstractPopupPanelpublic void setShadowDepth(String shadowDepth)
public String getShadowOpacity()
AbstractPopupPanel
getShadowOpacity in class AbstractPopupPanelpublic void setShadowOpacity(String shadowOpacity)
public boolean isShow()
AbstractPopupPanel
isShow in class AbstractPopupPanelpublic void setShow(boolean show)
setShow in class AbstractPopupPanelpublic String getStyle()
getStyle in class AbstractPopupPanelpublic void setStyle(String style)
public String getStyleClass()
getStyleClass in class AbstractPopupPanelpublic void setStyleClass(String styleClass)
public String getTop()
AbstractPopupPanel
getTop in class AbstractPopupPanelpublic void setTop(String top)
public boolean isTrimOverlayedElements()
AbstractPopupPanel
isTrimOverlayedElements in class AbstractPopupPanelpublic void setTrimOverlayedElements(boolean trimOverlayedElements)
public String getVisualOptions()
AbstractPopupPanel
getVisualOptions in class AbstractPopupPanelpublic void setVisualOptions(String visualOptions)
public int getWidth()
AbstractPopupPanel
getWidth in class AbstractPopupPanelpublic void setWidth(int width)
public int getZindex()
getZindex in class AbstractPopupPanelpublic void setZindex(int zindex)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||