Package org.apache.myfaces.view.facelets.tag.faces

Class ComponentSupport

java.lang.Object

org.apache.myfaces.view.facelets.tag.faces.ComponentSupport

public final class ComponentSupport
extends Object

Version:

$Id$

Author:

Jacob Hookom

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_ADDED_BY_HANDLER_MARKER	Special myfaces core marker to indicate the component is handled by a facelet tag handler, so its creation is not handled by user programatically and PSS remove listener should not register it when a remove happens.
static String	FACELET_STATE_INSTANCE	The key under the facelet state map is stored
static String	FACET_CREATED_UIPANEL_MARKER	The UIPanel components, which are dynamically generated to serve as a container for facets with multiple non panel children, are marked with this attribute.
static String	MARK_CREATED

Constructor Summary

Constructors

Constructor	Description
ComponentSupport()

Method Summary

Modifier and Type	Method	Description
static void	addFacet(FaceletContext ctx, UIComponent parent, UIComponent c, String facetName)
static void	encodeRecursive(FacesContext context, UIComponent toRender)
static UIComponent	findChild(UIComponent parent, String id)	A lighter-weight version of UIComponent's findChild.
static UIComponent	findChildByTagId(UIComponent parent, String id)	By TagId, find Child
static UIComponent	findChildInChildrenByTagId(UIComponent parent, String id)
static UIComponent	findChildInFacetByTagId(UIComponent parent, String id, String facetName)
static String	findChildInFacetsByTagId(UIComponent parent, String id)
static UIComponent	findComponentChildOrFacetFrom(UIComponent parent, String id, String innerExpr)
static UIComponent	findComponentChildOrFacetFrom(FacesContext facesContext, UIComponent parent, String expr)
static String	findFacetNameByComponentInstance(UIComponent parent, UIComponent instance)
static FaceletState	getFaceletState(FaceletContext ctx, UIComponent parent, boolean create)
static String	getFindComponentExpression(FacesContext facesContext, UIComponent component)
static Locale	getLocale(FaceletContext ctx, TagAttribute attr)	According to Faces 1.2 tag specs, this helper method will use the TagAttribute passed in determining the Locale intended.
static UIViewRoot	getViewRoot(FaceletContext ctx, UIComponent parent)	Tries to walk up the parent to find the UIViewRoot, if not found, then go to FaceletContext's FacesContext for the view root.
static void	markComponentToRefreshDynamically(FacesContext context, UIComponent component)
static void	markComponentToRestoreFully(FacesContext context, UIComponent component)
static void	removeFacet(FaceletContext ctx, UIComponent parent, UIComponent c, String facetName)
static void	removeTransient(UIComponent component)
static Object	restoreInitialTagState(FaceletContext ctx, FaceletCompositionContext fcc, UIComponent parent, String uniqueId)
static void	saveInitialTagState(FaceletContext ctx, FaceletCompositionContext fcc, UIComponent parent, String uniqueId, Object value)
static void	setCachedFacesContext(UIComponent component, FacesContext context)

Methods inherited from class java.lang.Object

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

Field Detail

MARK_CREATED

public static final String MARK_CREATED

See Also:

Constant Field Values

FACET_CREATED_UIPANEL_MARKER

public static final String FACET_CREATED_UIPANEL_MARKER

The UIPanel components, which are dynamically generated to serve as a container for facets with multiple non panel children, are marked with this attribute. This constant is duplicate in jakarta.faces.webapp.UIComponentClassicTagBase

See Also:

Constant Field Values

COMPONENT_ADDED_BY_HANDLER_MARKER

public static final String COMPONENT_ADDED_BY_HANDLER_MARKER

Special myfaces core marker to indicate the component is handled by a facelet tag handler, so its creation is not handled by user programatically and PSS remove listener should not register it when a remove happens.

See Also:

Constant Field Values

FACELET_STATE_INSTANCE

public static final String FACELET_STATE_INSTANCE

The key under the facelet state map is stored

See Also:

Constant Field Values

Constructor Detail

ComponentSupport

public ComponentSupport()

Method Detail

findChild

public static UIComponent findChild(UIComponent parent,
                                    String id)

A lighter-weight version of UIComponent's findChild.

Parameters:

parent - parent to start searching from

id - to match to

Returns:

UIComponent found or null

findFacetNameByComponentInstance

public static String findFacetNameByComponentInstance(UIComponent parent,
                                                      UIComponent instance)

findChildInFacetByTagId

public static UIComponent findChildInFacetByTagId(UIComponent parent,
                                                  String id,
                                                  String facetName)

findChildInChildrenByTagId

public static UIComponent findChildInChildrenByTagId(UIComponent parent,
                                                     String id)

findChildByTagId

public static UIComponent findChildByTagId(UIComponent parent,
                                           String id)

By TagId, find Child

Parameters:

parent -

id -

Returns:

findChildInFacetsByTagId

public static String findChildInFacetsByTagId(UIComponent parent,
                                              String id)

getLocale

public static Locale getLocale(FaceletContext ctx,
                               TagAttribute attr)
                        throws TagAttributeException

According to Faces 1.2 tag specs, this helper method will use the TagAttribute passed in determining the Locale intended.

Parameters:

ctx - FaceletContext to evaluate from

attr - TagAttribute representing a Locale

Returns:

Locale found

Throws:

TagAttributeException - if the Locale cannot be determined

getViewRoot

public static UIViewRoot getViewRoot(FaceletContext ctx,
                                     UIComponent parent)

Tries to walk up the parent to find the UIViewRoot, if not found, then go to FaceletContext's FacesContext for the view root.

Parameters:

ctx - FaceletContext

parent - UIComponent to search from

Returns:

UIViewRoot instance for this evaluation

encodeRecursive

public static void encodeRecursive(FacesContext context,
                                   UIComponent toRender)
                            throws IOException,
                                   FacesException

Throws:

IOException

FacesException

removeTransient

public static void removeTransient(UIComponent component)

addFacet

public static void addFacet(FaceletContext ctx,
                            UIComponent parent,
                            UIComponent c,
                            String facetName)

removeFacet

public static void removeFacet(FaceletContext ctx,
                               UIComponent parent,
                               UIComponent c,
                               String facetName)

markComponentToRestoreFully

public static void markComponentToRestoreFully(FacesContext context,
                                               UIComponent component)

markComponentToRefreshDynamically

public static void markComponentToRefreshDynamically(FacesContext context,
                                                     UIComponent component)

findComponentChildOrFacetFrom

public static UIComponent findComponentChildOrFacetFrom(FacesContext facesContext,
                                                        UIComponent parent,
                                                        String expr)

findComponentChildOrFacetFrom

public static UIComponent findComponentChildOrFacetFrom(UIComponent parent,
                                                        String id,
                                                        String innerExpr)

getFindComponentExpression

public static String getFindComponentExpression(FacesContext facesContext,
                                                UIComponent component)

restoreInitialTagState

public static Object restoreInitialTagState(FaceletContext ctx,
                                            FaceletCompositionContext fcc,
                                            UIComponent parent,
                                            String uniqueId)

saveInitialTagState

public static void saveInitialTagState(FaceletContext ctx,
                                       FaceletCompositionContext fcc,
                                       UIComponent parent,
                                       String uniqueId,
                                       Object value)

getFaceletState

public static FaceletState getFaceletState(FaceletContext ctx,
                                           UIComponent parent,
                                           boolean create)

setCachedFacesContext

public static void setCachedFacesContext(UIComponent component,
                                         FacesContext context)