org.apache.myfaces.view.facelets.tag.jsf
Class ComponentSupport

java.lang.Object
  org.apache.myfaces.view.facelets.tag.jsf.ComponentSupport

public final class ComponentSupport
extends java.lang.Object

Version:

$Id: ComponentSupport.java,v 1.8 2008/07/13 19:01:46 rlubke Exp $

Author:

Jacob Hookom

Field Summary

static java.lang.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 java.lang.String	MARK_CREATED

Constructor Summary

ComponentSupport()

Method Summary

static void	addFacet(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, javax.faces.component.UIComponent c, java.lang.String facetName)
static void	encodeRecursive(javax.faces.context.FacesContext context, javax.faces.component.UIComponent toRender)
static void	finalizeForDeletion(javax.faces.component.UIComponent component) Deprecated. use FaceletCompositionContext.finalizeForDeletion
static javax.faces.component.UIComponent	findChild(javax.faces.component.UIComponent parent, java.lang.String id) A lighter-weight version of UIComponent's findChild.
static javax.faces.component.UIComponent	findChildByTagId(javax.faces.component.UIComponent parent, java.lang.String id) By TagId, find Child
static java.util.Locale	getLocale(javax.faces.view.facelets.FaceletContext ctx, javax.faces.view.facelets.TagAttribute attr) According to JSF 1.2 tag specs, this helper method will use the TagAttribute passed in determining the Locale intended.
static javax.faces.component.UIViewRoot	getViewRoot(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.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 boolean	isNew(javax.faces.component.UIComponent component) Deprecated. use ComponentHandler.isNew
static void	markComponentToRestoreFully(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
static void	markForDeletion(javax.faces.component.UIComponent component) Deprecated. use FaceletCompositionContext.markForDeletion
static void	removeFacet(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, javax.faces.component.UIComponent c, java.lang.String facetName)
static void	removeTransient(javax.faces.component.UIComponent component)

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 java.lang.String MARK_CREATED

See Also:

Constant Field Values

FACET_CREATED_UIPANEL_MARKER

public static final java.lang.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 javax.faces.webapp.UIComponentClassicTagBase

See Also:

Constant Field Values

Constructor Detail

ComponentSupport

public ComponentSupport()

Method Detail

finalizeForDeletion

@Deprecated
public static void finalizeForDeletion(javax.faces.component.UIComponent component)

Deprecated. use FaceletCompositionContext.finalizeForDeletion

Used in conjunction with markForDeletion where any UIComponent marked will be removed.

Parameters:

component - UIComponent to finalize

findChild

public static javax.faces.component.UIComponent findChild(javax.faces.component.UIComponent parent,
                                                          java.lang.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

findChildByTagId

public static javax.faces.component.UIComponent findChildByTagId(javax.faces.component.UIComponent parent,
                                                                 java.lang.String id)

By TagId, find Child

Parameters:

parent -

id -

Returns:

getLocale

public static java.util.Locale getLocale(javax.faces.view.facelets.FaceletContext ctx,
                                         javax.faces.view.facelets.TagAttribute attr)
                                  throws javax.faces.view.facelets.TagAttributeException

According to JSF 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:

javax.faces.view.facelets.TagAttributeException - if the Locale cannot be determined

getViewRoot

public static javax.faces.component.UIViewRoot getViewRoot(javax.faces.view.facelets.FaceletContext ctx,
                                                           javax.faces.component.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

markForDeletion

@Deprecated
public static void markForDeletion(javax.faces.component.UIComponent component)

Deprecated. use FaceletCompositionContext.markForDeletion

Marks all direct children and Facets with an attribute for deletion.

Parameters:

component - UIComponent to mark

See Also:

finalizeForDeletion(UIComponent)

encodeRecursive

public static void encodeRecursive(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent toRender)
                            throws java.io.IOException,
                                   javax.faces.FacesException

Throws:

java.io.IOException

javax.faces.FacesException

removeTransient

public static void removeTransient(javax.faces.component.UIComponent component)

isNew

@Deprecated
public static boolean isNew(javax.faces.component.UIComponent component)

Deprecated. use ComponentHandler.isNew

Determine if the passed component is not null and if it's new to the tree. This operation can be used for determining if attributes should be wired to the component.

Parameters:

component - the component you wish to modify

Returns:

true if it's new

addFacet

public static void addFacet(javax.faces.view.facelets.FaceletContext ctx,
                            javax.faces.component.UIComponent parent,
                            javax.faces.component.UIComponent c,
                            java.lang.String facetName)

removeFacet

public static void removeFacet(javax.faces.view.facelets.FaceletContext ctx,
                               javax.faces.component.UIComponent parent,
                               javax.faces.component.UIComponent c,
                               java.lang.String facetName)

markComponentToRestoreFully

public static void markComponentToRestoreFully(javax.faces.context.FacesContext context,
                                               javax.faces.component.UIComponent component)