com.webmethods.caf.faces.bean
Class BaseCompositeViewControlPageBean

java.lang.Object
  extended by com.webmethods.caf.faces.bean.BaseFacesBean
      extended by com.webmethods.caf.faces.bean.BaseFacesSessionBean
          extended by com.webmethods.caf.faces.bean.BaseViewBean
              extended by com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean
All Implemented Interfaces:
IPageFlowScopeAdapter
Direct Known Subclasses:
PrincipalPickerControlBean, ResourcePickerControlBean

public class BaseCompositeViewControlPageBean
extends BaseViewBean

Base class for a page bean that is to be used for a composite view control

Since:
7.0

Nested Class Summary
 
Nested classes/interfaces inherited from class com.webmethods.caf.faces.bean.BaseViewBean
BaseViewBean.ClientIdsContentProvider
 
Field Summary
protected  UIComponent fCompositeNamingContainer
          Reference to the container UIComponent of the composite view control.
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseViewBean
clientIds, initialized
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean
fExpireWithPageFlow
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean
DATA_BINDING_CLIENTS, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders
 
Constructor Summary
BaseCompositeViewControlPageBean()
           
 
Method Summary
 UIComponent findComponentInRoot(String id)
          Overriding to treat the composite view naming container as the root control instead of the view root.
 IContentProvider getClientIds()
           Maps raw control ids to client-side element ids.
 String getCompositeViewAbsoluteControlId()
          Return the Absolute Control id of the composite view control.
 String getCompositeViewControlId()
          Return the id of the composite view control.
 UIComponent getCompositeViewNamingContainer()
          Get the container UIComponent of the composite view control.
protected  Object getPropertyOrBindingValue(String name, Class expectedType, Object specifiedValue, Object defaultValue)
          Gets property value using specified value, the ValueBinding for the specified name, or the default value.
 void setCompositeViewNamingContainer(AbstractCompositeViewControl namingContainer)
          Sets the container AbstractCompositeViewControl for this composite view control.
 void setCompositeViewNamingContainer(UIComponent namingContainer)
          Sets the container UIComponent for this composite view control.
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseViewBean
afterApplyRequestValues, afterInvokeApplication, afterPhase, afterProcessValidations, afterRenderResponse, afterRestoreView, afterUpdateModelValues, beforeApplyRequestValues, beforeInvokeApplication, beforePhase, beforeProcessValidations, beforeRenderResponse, beforeRestoreView, beforeUpdateModelValues, callInitialize, findComponent, getApplicationScope, getPhaseId, getRealPath, getRequestParam, getRequestScope, getSessionScope, gotoPage, gotoPage, initialize, isAsyncRequest, release, resetPageFlowStorage, streamFileDataToResponse
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean
getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean
createMethodBinding, createValueBinding, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fCompositeNamingContainer

protected transient UIComponent fCompositeNamingContainer
Reference to the container UIComponent of the composite view control.

Constructor Detail

BaseCompositeViewControlPageBean

public BaseCompositeViewControlPageBean()
Method Detail

getPropertyOrBindingValue

protected Object getPropertyOrBindingValue(String name,
                                           Class expectedType,
                                           Object specifiedValue,
                                           Object defaultValue)
Gets property value using specified value, the ValueBinding for the specified name, or the default value.

This method will return null only if the defaultValue is null.

Parameters:
name - Property name.
expectedType - The Class for type-converting the return value
specifiedValue - User-specified value.
defaultValue - Default value.
Returns:
Value in an Object of type defined by expectedType

setCompositeViewNamingContainer

public void setCompositeViewNamingContainer(AbstractCompositeViewControl namingContainer)
Sets the container AbstractCompositeViewControl for this composite view control.

See Also:
com.webmethods.caf.faces.component.ICompositeViewControlPageBean#setCompositeViewNamingContainer(com.webmethods.caf.faces.component.AbstractCompositeViewControl)

setCompositeViewNamingContainer

public void setCompositeViewNamingContainer(UIComponent namingContainer)
Sets the container UIComponent for this composite view control.

See Also:
com.webmethods.caf.faces.component.ICompositeViewControlPageBean#setCompositeViewNamingContainer(AbstractCompositeViewControl)

getCompositeViewNamingContainer

public UIComponent getCompositeViewNamingContainer()
Get the container UIComponent of the composite view control.

Returns:
UIComponent of the composite view control, or null if not found

getCompositeViewControlId

public String getCompositeViewControlId()
Return the id of the composite view control.

Returns:
the id of the composite view control, or null if not found

getCompositeViewAbsoluteControlId

public String getCompositeViewAbsoluteControlId()
Return the Absolute Control id of the composite view control.

Returns:
the id of the composite view control, or null if not found

getClientIds

public IContentProvider getClientIds()

Maps raw control ids to client-side element ids.

For example, #{myPageBean.clientIds.myControlId} returns the client-side id (ie "wmp1234:zID3:myControlId") for the control with an id of 'myControlId'.

Overrides:
getClientIds in class BaseViewBean
Returns:
instance of the content provider for ID mapping.

findComponentInRoot

public UIComponent findComponentInRoot(String id)
Overriding to treat the composite view naming container as the root control instead of the view root.

Overrides:
findComponentInRoot in class BaseViewBean
Parameters:
id - the component id
Returns:
UIComponent or null if not found
See Also:
BaseViewBean.findComponentInRoot(java.lang.String)