Package com.webmethods.caf.faces.component.panel

Class OverlayPanel

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

com.webmethods.caf.faces.component.panel.BaseHideablePanel

com.webmethods.caf.faces.component.panel.OverlayPanel

All Implemented Interfaces:

IHideablePanel, ILazyHideablePanel, ITableRowStateHolder, Serializable, EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

Direct Known Subclasses:

ProgressDialog

public class OverlayPanel
extends BaseHideablePanel

Initially hidden "hideable" panel that when displayed, covers another control.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Fields inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

ATTR_CENTER, ATTR_DEFAULT_COMMAND, ATTR_DEFAULT_FOCUS, ATTR_DISABLE_WHEN_HIDDEN, ATTR_HIDE_EFFECT, ATTR_HIDE_EFFECT_OPTIONS, ATTR_OPACITY, ATTR_PROGRESS_DELAY, ATTR_PROGRESS_FLASH_ON_COMPLETE, ATTR_PROGRESS_MSG, ATTR_PROGRESS_USE_HIDE_SHOW_EFFECT, ATTR_SHOW_EFFECT, ATTR_SHOW_EFFECT_OPTIONS, m_savedSuppressed, m_savedVisible

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY, 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

Constructors

Constructor	Description
OverlayPanel()

Method Summary

Modifier and Type	Method	Description
void	encodeChildren(FacesContext context)
String	getFor()
String	getHideEffect()
String	getShowEffect()
boolean	isVisible()	Override to change the default value True if initially visible.
void	setFor(String _for)
void	setHideEffect(String hideEffect)
void	setShowEffect(String showEffect)

Methods inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

decode, encodeBegin, encodeEnd, findSuppressed, getRendersChildren, getSuppressInputs, getTableRowState, isAncestorOrSelf, isDisableWhenHidden, isLazy, isRefreshOnShow, isTwoPass, processDecodes, processUpdates, processValidators, setDisableWhenHidden, setLazy, setRefreshOnShow, setSuppressInputs, setTableRowState, setTwoPass, setVisible

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, 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 Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

OverlayPanel

public OverlayPanel()

Method Details

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class BaseHideablePanel

Throws:

IOException

isVisible

public boolean isVisible()

Override to change the default value True if initially visible.

Specified by:

isVisible in interface IHideablePanel

Overrides:

isVisible in class BaseHideablePanel

getFor

public String getFor()

setFor

public void setFor(String _for)

getHideEffect

public String getHideEffect()

setHideEffect

public void setHideEffect(String hideEffect)

getShowEffect

public String getShowEffect()

setShowEffect

public void setShowEffect(String showEffect)