javax.portlet.faces.component
Class PortletNamingContainerUIViewRoot

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIViewRoot
              extended by javax.portlet.faces.component.PortletNamingContainerUIViewRoot
All Implemented Interfaces:
Serializable, StateHolder

@PortletNamingContainer
public class PortletNamingContainerUIViewRoot
extends UIViewRoot
implements Serializable

UIViewRoot that implements portlet specific NamingContainer that ensures the consumer's unique portlet Id is encoded in all tree components. The class is annotated by javax.portlet.faces.annotation.PortletNamingContainer allowing the bridge to recognize that this specific UIViewRoot implements the behavior.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.faces.component.UIViewRoot
COMPONENT_FAMILY, COMPONENT_TYPE, UNIQUE_ID_PREFIX
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
PortletNamingContainerUIViewRoot()
           
PortletNamingContainerUIViewRoot(UIViewRoot viewRootToReplace)
           
 
Method Summary
 String getContainerClientId(FacesContext context)
          Implements NamingContainer semantics.
static String getContainerClientId(FacesContext context, String additionalId)
          Static method that implements NamingContainer semantics.
 
Methods inherited from class javax.faces.component.UIViewRoot
addPhaseListener, createUniqueId, encodeBegin, encodeEnd, getAfterPhaseListener, getBeforePhaseListener, getFamily, getLocale, getRenderKitId, getViewId, processApplication, processDecodes, processUpdates, processValidators, queueEvent, removePhaseListener, restoreState, saveState, setAfterPhaseListener, setBeforePhaseListener, setLocale, setRenderKitId, setViewId
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletNamingContainerUIViewRoot

public PortletNamingContainerUIViewRoot()

PortletNamingContainerUIViewRoot

public PortletNamingContainerUIViewRoot(UIViewRoot viewRootToReplace)
Method Detail

getContainerClientId

public static String getContainerClientId(FacesContext context,
                                          String additionalId)
Static method that implements NamingContainer semantics. Ensures that the returned identifier contains the consumer (portal) provided unique portlet id. This ensures that those components in this NamingContainer generate ids which will not collide in the consumer page.

This method is provided for existing UIViewRoot implementations that prefer not to subclass PortletNamingContainerUIViewRoot


getContainerClientId

public String getContainerClientId(FacesContext context)
Implements NamingContainer semantics. Ensures that the returned identifier contains the consumer (portal) provided unique portlet id. This ensures that those components in this NamingContainer generate ids which will not collide in the consumer page. Implementation merely calls the static form of this method.

Overrides:
getContainerClientId in class UIComponent


Copyright © 2007-2008 The Apache Software Foundation. All Rights Reserved.