org.openfaces.component.window
Class PopupLayer

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by org.openfaces.component.OUIPanel
                  extended by org.openfaces.component.window.PopupLayer
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, OUIComponent
Direct Known Subclasses:
AbstractWindow, ChartPopup

public class PopupLayer
extends OUIPanel

The PopupLayer component is a container for other JSF components that is displayed over the page contents. The size, placement, timeout value, and modality of the component can be easily customized. A convenient API lets you manage the display behavior of the PopupLayer component on the client side.


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
PopupLayer()
           
 
Method Summary
 java.lang.String getAnchorElementId()
           
 java.lang.String getAnchorX()
           
 java.lang.String getAnchorY()
           
 boolean getDraggable()
           
 java.lang.String getFamily()
           
 java.lang.String getHeight()
           
 boolean getHideOnEsc()
           
 boolean getHideOnOuterClick()
           
 int getHidingTimeout()
           
 java.lang.String getLeft()
           
 java.lang.String getModalLayerClass()
           
 java.lang.String getModalLayerStyle()
           
 java.lang.String getOndragend()
           
 java.lang.String getOndragstart()
           
 java.lang.String getOnhide()
           
 java.lang.String getOnshow()
           
 java.lang.String getTop()
           
 java.lang.String getWidth()
           
 boolean isModal()
           
 boolean isVisible()
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAnchorElementId(java.lang.String anchorElementId)
           
 void setAnchorX(java.lang.String anchorX)
           
 void setAnchorY(java.lang.String anchorY)
           
 void setDraggable(boolean draggable)
           
 void setHeight(java.lang.String height)
           
 void setHideOnEsc(boolean hideOnEsc)
           
 void setHideOnOuterClick(boolean hideOnOuterClick)
           
 void setHidingTimeout(int hidingTimeout)
           
 void setLeft(java.lang.String left)
           
 void setModal(boolean modal)
           
 void setModalLayerClass(java.lang.String modalLayerClass)
           
 void setModalLayerStyle(java.lang.String modalLayerStyle)
           
 void setOndragend(java.lang.String ondragend)
           
 void setOndragstart(java.lang.String ondragstart)
           
 void setOnhide(java.lang.String onhide)
           
 void setOnshow(java.lang.String onshow)
           
 void setTop(java.lang.String top)
           
 void setVisible(boolean visible)
           
 void setWidth(java.lang.String width)
           
 
Methods inherited from class org.openfaces.component.OUIPanel
getOnblur, getOnclick, getOncontextmenu, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRolloverClass, getRolloverStyle, getStyle, getStyleClass, setOnblur, setOnclick, setOncontextmenu, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRolloverClass, setRolloverStyle, setStyle, setStyleClass
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getValueExpression, initialStateMarked, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

PopupLayer

public PopupLayer()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class OUIPanel

getModalLayerStyle

public java.lang.String getModalLayerStyle()

setModalLayerStyle

public void setModalLayerStyle(java.lang.String modalLayerStyle)

getModalLayerClass

public java.lang.String getModalLayerClass()

setModalLayerClass

public void setModalLayerClass(java.lang.String modalLayerClass)

getHideOnOuterClick

public boolean getHideOnOuterClick()

setHideOnOuterClick

public void setHideOnOuterClick(boolean hideOnOuterClick)

getHideOnEsc

public boolean getHideOnEsc()

setHideOnEsc

public void setHideOnEsc(boolean hideOnEsc)

isModal

public boolean isModal()

setModal

public void setModal(boolean modal)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

getOndragstart

public java.lang.String getOndragstart()

setOndragstart

public void setOndragstart(java.lang.String ondragstart)

getOndragend

public java.lang.String getOndragend()

setOndragend

public void setOndragend(java.lang.String ondragend)

getDraggable

public boolean getDraggable()

setDraggable

public void setDraggable(boolean draggable)

getAnchorElementId

public java.lang.String getAnchorElementId()

setAnchorElementId

public void setAnchorElementId(java.lang.String anchorElementId)

getAnchorX

public java.lang.String getAnchorX()

setAnchorX

public void setAnchorX(java.lang.String anchorX)

getAnchorY

public java.lang.String getAnchorY()

setAnchorY

public void setAnchorY(java.lang.String anchorY)

getLeft

public java.lang.String getLeft()

setLeft

public void setLeft(java.lang.String left)

getTop

public java.lang.String getTop()

setTop

public void setTop(java.lang.String top)

getWidth

public java.lang.String getWidth()

setWidth

public void setWidth(java.lang.String width)

getHeight

public java.lang.String getHeight()

setHeight

public void setHeight(java.lang.String height)

getOnshow

public java.lang.String getOnshow()

setOnshow

public void setOnshow(java.lang.String onshow)

getOnhide

public java.lang.String getOnhide()

setOnhide

public void setOnhide(java.lang.String onhide)

getHidingTimeout

public int getHidingTimeout()

setHidingTimeout

public void setHidingTimeout(int hidingTimeout)

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class javax.faces.component.UIComponentBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class OUIPanel

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class OUIPanel


Copyright © 1998-2010 TeamDev Ltd. All Rights Reserved.