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

Class BaseHideablePanel

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCompositeViewControl, LazyHideablePanel, ModalDialog, ModelessDialog, OverlayPanel, ProgressBar, ToggleMenus.SecondLevelPanel

public class BaseHideablePanel
extends UIPanel
implements ILazyHideablePanel, ITableRowStateHolder

Panel that can be toggled between hidden and visible.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	BaseHideablePanel.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_CENTER
static final String	ATTR_DEFAULT_COMMAND
static final String	ATTR_DEFAULT_FOCUS
static final String	ATTR_DISABLE_WHEN_HIDDEN
static final String	ATTR_HIDE_EFFECT
static final String	ATTR_HIDE_EFFECT_OPTIONS
static final String	ATTR_OPACITY
static final String	ATTR_PROGRESS_DELAY
static final String	ATTR_PROGRESS_FLASH_ON_COMPLETE
static final String	ATTR_PROGRESS_MSG
static final String	ATTR_PROGRESS_USE_HIDE_SHOW_EFFECT
static final String	ATTR_SHOW_EFFECT
static final String	ATTR_SHOW_EFFECT_OPTIONS
protected Map<UIComponent,Boolean>	m_savedSuppressed
protected Boolean	m_savedVisible
static final String	TYPE

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
BaseHideablePanel()

Method Summary

Modifier and Type	Method	Description
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
Collection<UIComponent>	findSuppressed()	Collection of UIComponent suppressed inputs.
boolean	getRendersChildren()
Collection<String>	getSuppressInputs()	Collection of String control ids on which to disallow update processing while handling asynchorously request.
Object	getTableRowState()	Gets this control's per-row state.
boolean	isAncestorOrSelf(UIComponent c)	True if component is ancestor or self, false otherwise.
boolean	isDisableWhenHidden()
boolean	isLazy()	True if panel loads content asynchronously on demand.
boolean	isRefreshOnShow()	True to refresh content asynchronously every time panel is toggled visible.
boolean	isTwoPass()	True if panel content is rendered asynchronously, even if initially visible.
boolean	isVisible()	True if initially visible.
void	processDecodes(FacesContext context)
void	processUpdates(FacesContext context)
void	processValidators(FacesContext context)
void	setDisableWhenHidden(boolean disableWhenHidden)
void	setLazy(boolean lazy)	True if panel loads content asynchronously on demand.
void	setRefreshOnShow(boolean refreshOnShow)	True to refresh content asynchronously every time panel is toggled visible.
void	setSuppressInputs(Collection<String> suppressInputs)	Collection of String control ids on which to disallow update processing while handling asynchorously request.
void	setTableRowState(Object o)	Sets this control's per-row state.
void	setTwoPass(boolean twoPass)	True if panel content is rendered asynchronously, even if initially visible.
void	setVisible(boolean visible)	True if initially visible.

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

ATTR_CENTER

public static final String ATTR_CENTER

See Also:

• Constant Field Values

ATTR_DEFAULT_COMMAND

public static final String ATTR_DEFAULT_COMMAND

See Also:

• Constant Field Values

ATTR_DEFAULT_FOCUS

public static final String ATTR_DEFAULT_FOCUS

See Also:

• Constant Field Values

ATTR_DISABLE_WHEN_HIDDEN

public static final String ATTR_DISABLE_WHEN_HIDDEN

See Also:

• Constant Field Values

ATTR_HIDE_EFFECT

public static final String ATTR_HIDE_EFFECT

See Also:

• Constant Field Values

ATTR_HIDE_EFFECT_OPTIONS

public static final String ATTR_HIDE_EFFECT_OPTIONS

See Also:

• Constant Field Values

ATTR_OPACITY

public static final String ATTR_OPACITY

See Also:

• Constant Field Values

ATTR_PROGRESS_DELAY

public static final String ATTR_PROGRESS_DELAY

See Also:

• Constant Field Values

ATTR_PROGRESS_FLASH_ON_COMPLETE

public static final String ATTR_PROGRESS_FLASH_ON_COMPLETE

See Also:

• Constant Field Values

ATTR_PROGRESS_MSG

public static final String ATTR_PROGRESS_MSG

See Also:

• Constant Field Values

ATTR_PROGRESS_USE_HIDE_SHOW_EFFECT

public static final String ATTR_PROGRESS_USE_HIDE_SHOW_EFFECT

See Also:

• Constant Field Values

ATTR_SHOW_EFFECT

public static final String ATTR_SHOW_EFFECT

See Also:

• Constant Field Values

ATTR_SHOW_EFFECT_OPTIONS

public static final String ATTR_SHOW_EFFECT_OPTIONS

See Also:

• Constant Field Values

m_savedSuppressed

protected transient Map<UIComponent,Boolean> m_savedSuppressed

m_savedVisible

protected transient Boolean m_savedVisible

Constructor Details

BaseHideablePanel

public BaseHideablePanel()

Method Details

getTableRowState

public Object getTableRowState()

Gets this control's per-row state.

Specified by:

getTableRowState in interface ITableRowStateHolder

setTableRowState

public void setTableRowState(Object o)

Sets this control's per-row state.

Specified by:

setTableRowState in interface ITableRowStateHolder

processDecodes

public void processDecodes(FacesContext context)

Overrides:

processDecodes in class UIComponentBase

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class UIComponentBase

processUpdates

public void processUpdates(FacesContext context)

Overrides:

processUpdates in class UIComponentBase

decode

public void decode(FacesContext context)

Overrides:

decode in class UIComponentBase

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

findSuppressed

public Collection<UIComponent> findSuppressed()

Collection of UIComponent suppressed inputs. Never null.

isAncestorOrSelf

public boolean isAncestorOrSelf(UIComponent c)

True if component is ancestor or self, false otherwise. Null allowed.

isVisible

public boolean isVisible()

Description copied from interface: IHideablePanel

True if initially visible.

Specified by:

isVisible in interface IHideablePanel

setVisible

public void setVisible(boolean visible)

Description copied from interface: IHideablePanel

True if initially visible.

Specified by:

setVisible in interface IHideablePanel

isLazy

public boolean isLazy()

Description copied from interface: ILazyHideablePanel

True if panel loads content asynchronously on demand.

Specified by:

isLazy in interface ILazyHideablePanel

setLazy

public void setLazy(boolean lazy)

Description copied from interface: ILazyHideablePanel

True if panel loads content asynchronously on demand.

Specified by:

setLazy in interface ILazyHideablePanel

isRefreshOnShow

public boolean isRefreshOnShow()

Description copied from interface: ILazyHideablePanel

True to refresh content asynchronously every time panel is toggled visible. Ignored if not lazy.

Specified by:

isRefreshOnShow in interface ILazyHideablePanel

setRefreshOnShow

public void setRefreshOnShow(boolean refreshOnShow)

Description copied from interface: ILazyHideablePanel

True to refresh content asynchronously every time panel is toggled visible. Ignored if not lazy.

Specified by:

setRefreshOnShow in interface ILazyHideablePanel

isTwoPass

public boolean isTwoPass()

Description copied from interface: ILazyHideablePanel

True if panel content is rendered asynchronously, even if initially visible. Ignored if not lazy.

Specified by:

isTwoPass in interface ILazyHideablePanel

setTwoPass

public void setTwoPass(boolean twoPass)

Description copied from interface: ILazyHideablePanel

True if panel content is rendered asynchronously, even if initially visible. Ignored if not lazy.

Specified by:

setTwoPass in interface ILazyHideablePanel

isDisableWhenHidden

public boolean isDisableWhenHidden()

setDisableWhenHidden

public void setDisableWhenHidden(boolean disableWhenHidden)

getSuppressInputs

public Collection<String> getSuppressInputs()

Description copied from interface: ILazyHideablePanel

Collection of String control ids on which to disallow update processing while handling asynchorously request. By default, all controls are allowed.

Specified by:

getSuppressInputs in interface ILazyHideablePanel

setSuppressInputs

public void setSuppressInputs(Collection<String> suppressInputs)

Description copied from interface: ILazyHideablePanel

Collection of String control ids on which to disallow update processing while handling asynchorously request. By default, all controls are allowed.

Specified by:

setSuppressInputs in interface ILazyHideablePanel