org.richfaces.component
Interface MetaComponentResolver


public interface MetaComponentResolver

Author:
Nick Belaevski

Field Summary
static char META_COMPONENT_SEPARATOR_CHAR
           
 
Method Summary
 java.lang.String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, java.lang.String metaComponentId)
          Resolves and returns string identifying supported meta-component or null if provided meta-component name is not a supported one.
 java.lang.String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, java.lang.String metaComponentId)
          Provides replacement for unresolved meta-component names.
 

Field Detail

META_COMPONENT_SEPARATOR_CHAR

static final char META_COMPONENT_SEPARATOR_CHAR
See Also:
Constant Field Values
Method Detail

resolveClientId

java.lang.String resolveClientId(javax.faces.context.FacesContext facesContext,
                                 javax.faces.component.UIComponent contextComponent,
                                 java.lang.String metaComponentId)
Resolves and returns string identifying supported meta-component or null if provided meta-component name is not a supported one.

Parameters:
facesContext - - current instance of FacesContext
contextComponent - - instance of UIComponent that requested resolution of meta-component
metaComponentId - - name of meta-component (without leading '@' sign)
Returns:
clientId, one of supported meta-names such as @all, @this, etc. or null

substituteUnresolvedClientId

java.lang.String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
                                              javax.faces.component.UIComponent contextComponent,
                                              java.lang.String metaComponentId)
Provides replacement for unresolved meta-component names. Returns identifier string for the chosen substitution or null

Parameters:
facesContext - - current instance of FacesContext
contextComponent - - instance of UIComponent that requested resolution of meta-component
metaComponentId - - name of meta-component (without leading '@' sign)
Returns:
clientId, one of supported meta-names such as @all, @this, etc. or null


Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.