org.primefaces.component.overlaypanel
Class OverlayPanel

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              org.primefaces.component.overlaypanel.OverlayPanel

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Widget

public class OverlayPanel
extends javax.faces.component.UIPanel
implements Widget

Nested Class Summary

protected static class

OverlayPanel.PropertyKeys

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTENT_CLASS
static String	STYLE_CLASS

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

OverlayPanel()

Method Summary

String	getAt()
String	getFamily()
String	getFor()
String	getHideEffect()
String	getHideEvent()
String	getMy()
String	getOnHide()
String	getOnShow()
String	getShowEffect()
String	getShowEvent()
String	getStyle()
String	getStyleClass()
String	getWidgetVar()
boolean	isAppendToBody()
boolean	isContentLoadRequest(javax.faces.context.FacesContext context)
boolean	isDismissable()
boolean	isDynamic()
boolean	isShowCloseIcon()
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
String	resolveWidgetVar()
void	setAppendToBody(boolean _appendToBody)
void	setAt(String _at)
void	setDismissable(boolean _dismissable)
void	setDynamic(boolean _dynamic)
void	setFor(String _for)
void	setHideEffect(String _hideEffect)
void	setHideEvent(String _hideEvent)
void	setMy(String _my)
void	setOnHide(String _onHide)
void	setOnShow(String _onShow)
void	setShowCloseIcon(boolean _showCloseIcon)
void	setShowEffect(String _showEffect)
void	setShowEvent(String _showEvent)
void	setStyle(String _style)
void	setStyleClass(String _styleClass)
void	setWidgetVar(String _widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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, getPassThroughAttributes, 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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

STYLE_CLASS

public static final String STYLE_CLASS

See Also:

Constant Field Values

CONTENT_CLASS

public static final String CONTENT_CLASS

See Also:

Constant Field Values

Constructor Detail

OverlayPanel

public OverlayPanel()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String _widgetVar)

getStyle

public String getStyle()

setStyle

public void setStyle(String _style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String _styleClass)

getFor

public String getFor()

setFor

public void setFor(String _for)

getShowEvent

public String getShowEvent()

setShowEvent

public void setShowEvent(String _showEvent)

getHideEvent

public String getHideEvent()

setHideEvent

public void setHideEvent(String _hideEvent)

getShowEffect

public String getShowEffect()

setShowEffect

public void setShowEffect(String _showEffect)

getHideEffect

public String getHideEffect()

setHideEffect

public void setHideEffect(String _hideEffect)

isAppendToBody

public boolean isAppendToBody()

setAppendToBody

public void setAppendToBody(boolean _appendToBody)

getOnShow

public String getOnShow()

setOnShow

public void setOnShow(String _onShow)

getOnHide

public String getOnHide()

setOnHide

public void setOnHide(String _onHide)

getMy

public String getMy()

setMy

public void setMy(String _my)

getAt

public String getAt()

setAt

public void setAt(String _at)

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean _dynamic)

isDismissable

public boolean isDismissable()

setDismissable

public void setDismissable(boolean _dismissable)

isShowCloseIcon

public boolean isShowCloseIcon()

setShowCloseIcon

public void setShowCloseIcon(boolean _showCloseIcon)

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

isContentLoadRequest

public boolean isContentLoadRequest(javax.faces.context.FacesContext context)

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget