Package com.webmethods.caf.faces.component

Class AbstractCompositeViewControl

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.AbstractCompositeViewControl

All Implemented Interfaces:

IDynamicComponent, IHideablePanel, ILazyHideablePanel, IPostPageComponentPhaseListener, IScopedVariableComponent, ITableRowStateHolder, Serializable, EventListener, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, PhaseListener, SystemEventListenerHolder

Direct Known Subclasses:

AbstractCompositeViewModalDialog, AttachmentsList, AttachmentsPanel, ExportTableButton, PeopleSwapBox, SearchBar

public abstract class AbstractCompositeViewControl
extends BaseHideablePanel
implements PhaseListener, NamingContainer, IPostPageComponentPhaseListener, IScopedVariableComponent, IDynamicComponent

This base class can be used to help expose a prototyped .view + page bean as a control. NOTE: The supplied .view file should not be binding anything to portlet preferences as the control may be used outside the scope of a specific portlet.

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractCompositeViewControl.BindingExpressionReWriter

Nested classes/interfaces inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

BaseHideablePanel.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Serializable,Object>	_deferredPropertiesMap
protected static final String	ATTR__VIEW_LOADED
protected Integer	fInstanceNumber
protected String	fPrototypedPageBeanName
protected String	fViewResourcePath
static final String	PORTLET_VIEW_ID

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCompositeViewControl(String viewResourcePath, String prototypedPageBeanName)

Method Summary

Modifier and Type	Method	Description
void	afterPhase(PhaseEvent event)
protected void	applyDeferredProperties()	Apply any changes in the deferred properties map to the underlying controls.
protected void	associateControlWithBean()
protected void	associateControlWithBean(Object pageBean)
void	beforePhase(PhaseEvent event)
void	clearPageBean()
protected abstract Serializable	createPageBean()
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
void	ensureEmbeddedViewIsLoaded()	Loads the embedded view as as children of this control, if the view has not already been loaded.
protected Map<Serializable,Object>	getDeferredPropertiesMap()
protected Object	getInternalPageBean()
protected Object	getInternalPageBean(boolean createIfMissing)
protected String	getInternalPageBeanName()	Deprecated.
protected Set<String>	getPageNamesToReplaceInBindingExpressions()	Return the names of the page beans to replace when the binding expressions in the .view file are re-written.
PhaseId	getPhaseId()
PhaseId	getPostPagePhaseId()
Object	getScopedVariable()	Gets the scoped variable object
String	getScopedVariableName()	Get the name of the scoped variable
protected void	importChildrenFromView(UIViewRoot view)	Imports the children from the view to this control
protected void	loadView(String viewResourcePath)
void	populateInitialComponents()	Perform the initial programmatic manipulation of the component tree.
void	postPageAfterPhase(PhaseEvent event)
void	postPageBeforePhase(PhaseEvent event)
void	processDecodes(FacesContext context)
void	processEvent(ComponentSystemEvent event)
protected void	processLoadView(String viewResourcePath)
void	processRestoreState(FacesContext context, Object state)
Object	processSaveState(FacesContext context)
void	processUpdates(FacesContext context)
void	processValidators(FacesContext context)
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
boolean	visitTree(VisitContext context, VisitCallback callback)

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

decode, findSuppressed, getRendersChildren, getSuppressInputs, getTableRowState, isAncestorOrSelf, isDisableWhenHidden, isLazy, isRefreshOnShow, isTwoPass, isVisible, 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, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, 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, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ATTR__VIEW_LOADED

protected static final String ATTR__VIEW_LOADED

See Also:

• Constant Field Values

PORTLET_VIEW_ID

public static final String PORTLET_VIEW_ID

See Also:

• Constant Field Values

_deferredPropertiesMap

protected transient Map<Serializable,Object> _deferredPropertiesMap

fPrototypedPageBeanName

protected String fPrototypedPageBeanName

fViewResourcePath

protected String fViewResourcePath

fInstanceNumber

protected Integer fInstanceNumber

Constructor Details

AbstractCompositeViewControl

protected AbstractCompositeViewControl(String viewResourcePath,
 String prototypedPageBeanName)

Method Details

getDeferredPropertiesMap

protected Map<Serializable,Object> getDeferredPropertiesMap()

getInternalPageBeanName

@Deprecated
protected String getInternalPageBeanName()

Deprecated.

Kept for backward compatibility. Use getPageBeanName instead.

Returns:

getInternalPageBean

protected Object getInternalPageBean()

getInternalPageBean

protected Object getInternalPageBean(boolean createIfMissing)

getPageNamesToReplaceInBindingExpressions

protected Set<String> getPageNamesToReplaceInBindingExpressions()

Return the names of the page beans to replace when the binding expressions in the .view file are re-written.

createPageBean

protected abstract Serializable createPageBean()

clearPageBean

public void clearPageBean()

loadView

protected void loadView(String viewResourcePath)

processLoadView

protected void processLoadView(String viewResourcePath)

importChildrenFromView

protected void importChildrenFromView(UIViewRoot view)

Imports the children from the view to this control

Parameters:

view - the imported view

See Also:

• loadView(String)

restoreState

public void restoreState(FacesContext context,
 Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

ensureEmbeddedViewIsLoaded

public void ensureEmbeddedViewIsLoaded()

Loads the embedded view as as children of this control, if the view has not already been loaded.

beforePhase

public void beforePhase(PhaseEvent event)

Specified by:

beforePhase in interface PhaseListener

afterPhase

public void afterPhase(PhaseEvent event)

Specified by:

afterPhase in interface PhaseListener

getPhaseId

public PhaseId getPhaseId()

Specified by:

getPhaseId in interface PhaseListener

associateControlWithBean

protected void associateControlWithBean()

associateControlWithBean

protected void associateControlWithBean(Object pageBean)

getPostPagePhaseId

public PhaseId getPostPagePhaseId()

Specified by:

getPostPagePhaseId in interface IPostPageComponentPhaseListener

postPageBeforePhase

public void postPageBeforePhase(PhaseEvent event)

Specified by:

postPageBeforePhase in interface IPostPageComponentPhaseListener

postPageAfterPhase

public void postPageAfterPhase(PhaseEvent event)

Specified by:

postPageAfterPhase in interface IPostPageComponentPhaseListener

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class BaseHideablePanel

Throws:

IOException

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class BaseHideablePanel

Throws:

IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class BaseHideablePanel

Throws:

IOException

processDecodes

public void processDecodes(FacesContext context)

Overrides:

processDecodes in class BaseHideablePanel

processRestoreState

public void processRestoreState(FacesContext context,
 Object state)

Overrides:

processRestoreState in class UIComponentBase

processSaveState

public Object processSaveState(FacesContext context)

Overrides:

processSaveState in class UIComponentBase

processUpdates

public void processUpdates(FacesContext context)

Overrides:

processUpdates in class BaseHideablePanel

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class BaseHideablePanel

visitTree

public boolean visitTree(VisitContext context,
 VisitCallback callback)

Overrides:

visitTree in class UIComponent

getScopedVariableName

public String getScopedVariableName()

Description copied from interface: IScopedVariableComponent

Get the name of the scoped variable

Specified by:

getScopedVariableName in interface IScopedVariableComponent

Returns:

getScopedVariable

public Object getScopedVariable()

Description copied from interface: IScopedVariableComponent

Gets the scoped variable object

Specified by:

getScopedVariable in interface IScopedVariableComponent

Returns:

variable object

processEvent

public void processEvent(ComponentSystemEvent event)
                  throws AbortProcessingException

Specified by:

processEvent in interface ComponentSystemEventListener

Overrides:

processEvent in class UIComponent

Throws:

AbortProcessingException

populateInitialComponents

public void populateInitialComponents()

Description copied from interface: IDynamicComponent

Perform the initial programmatic manipulation of the component tree.

Specified by:

populateInitialComponents in interface IDynamicComponent

applyDeferredProperties

protected void applyDeferredProperties()

Apply any changes in the deferred properties map to the underlying controls.