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

java.lang.Object
  extended by 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(FaceletContext ctx, UIComponent parent, UIComponent c, java.lang.String facetName)
           
static void encodeRecursive(FacesContext context, UIComponent toRender)
           
static void finalizeForDeletion(UIComponent component)
          Used in conjunction with markForDeletion where any UIComponent marked will be removed.
static UIComponent findChild(UIComponent parent, java.lang.String id)
          A lighter-weight version of UIComponent's findChild.
static UIComponent findChildByTagId(UIComponent parent, java.lang.String id)
          By TagId, find Child
static java.util.Locale getLocale(FaceletContext ctx, TagAttribute attr)
          According to JSF 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 boolean isNew(UIComponent component)
          Deprecated. use ComponentHandler.isNew
static void markComponentToRestoreFully(FacesContext context, UIComponent component)
           
static void markForDeletion(UIComponent component)
          Marks all direct children and Facets with an attribute for deletion.
static void removeFacet(FaceletContext ctx, UIComponent parent, UIComponent c, java.lang.String facetName)
           
static void removeTransient(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

public static void finalizeForDeletion(UIComponent component)
Used in conjunction with markForDeletion where any UIComponent marked will be removed.

Parameters:
component - UIComponent to finalize

findChild

public static UIComponent findChild(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 UIComponent findChildByTagId(UIComponent parent,
                                           java.lang.String id)
By TagId, find Child

Parameters:
parent -
id -
Returns:

getLocale

public static java.util.Locale getLocale(FaceletContext ctx,
                                         TagAttribute attr)
                                  throws 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:
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

markForDeletion

public static void markForDeletion(UIComponent component)
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(FacesContext context,
                                   UIComponent toRender)
                            throws java.io.IOException,
                                   FacesException
Throws:
java.io.IOException
FacesException

removeTransient

public static void removeTransient(UIComponent component)

isNew

@Deprecated
public static boolean isNew(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(FaceletContext ctx,
                            UIComponent parent,
                            UIComponent c,
                            java.lang.String facetName)

removeFacet

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

markComponentToRestoreFully

public static void markComponentToRestoreFully(FacesContext context,
                                               UIComponent component)


Copyright © 2010 The Apache Software Foundation. All Rights Reserved.