org.primefaces.util

Class ComponentTraversalUtils

java.lang.Object

org.primefaces.util.ComponentTraversalUtils

public class ComponentTraversalUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentTraversalUtils.IdContextCallback
static class	ComponentTraversalUtils.IdVisitCallback

Constructor Summary

Constructors

Constructor and Description
ComponentTraversalUtils()

Method Summary

Modifier and Type	Method and Description
static <T> ArrayList<T>	children(Class<T> type, javax.faces.component.UIComponent base)
static <T> T	closest(Class<T> type, javax.faces.component.UIComponent base)
static javax.faces.component.UIForm	closestForm(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
static javax.faces.component.UIComponent	closestNamingContainer(javax.faces.component.UIComponent component)
static javax.faces.component.UniqueIdVendor	closestUniqueIdVendor(javax.faces.component.UIComponent component)
static <T> T	first(Class<T> type, javax.faces.component.UIComponent base)
static javax.faces.component.UIComponent	firstById(String id, javax.faces.component.UIComponent base, String separatorString, javax.faces.context.FacesContext context) Finds the first component by the given id expression or client id.
static javax.faces.component.UIComponent	firstById(String id, javax.faces.component.UIComponent base, String separatorString, javax.faces.context.FacesContext context, boolean skipUnrendered) Finds the first component by the given id expression or client id.
static javax.faces.component.UIComponent	firstWithId(String id, javax.faces.component.UIComponent base) Finds the first component with the given id (NOT clientId!).
static void	withId(String id, javax.faces.component.UIComponent base, List<javax.faces.component.UIComponent> components)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentTraversalUtils

public ComponentTraversalUtils()

Method Detail

closest

public static <T> T closest(Class<T> type,
                            javax.faces.component.UIComponent base)

first

public static <T> T first(Class<T> type,
                          javax.faces.component.UIComponent base)

children

public static <T> ArrayList<T> children(Class<T> type,
                                        javax.faces.component.UIComponent base)

withId

public static void withId(String id,
                          javax.faces.component.UIComponent base,
                          List<javax.faces.component.UIComponent> components)

firstWithId

public static javax.faces.component.UIComponent firstWithId(String id,
                                                            javax.faces.component.UIComponent base)

Finds the first component with the given id (NOT clientId!).

Parameters:

id - The id.

base - The base component to start the traversal.

Returns:

The component or null.

firstById

public static javax.faces.component.UIComponent firstById(String id,
                                                          javax.faces.component.UIComponent base,
                                                          String separatorString,
                                                          javax.faces.context.FacesContext context)

Finds the first component by the given id expression or client id.

Parameters:

id - The id.

base - The base component to start the traversal.

separatorString - The seperatorString (e.g. :).

context - The FacesContext.

Returns:

The component or null.

firstById

public static javax.faces.component.UIComponent firstById(String id,
                                                          javax.faces.component.UIComponent base,
                                                          String separatorString,
                                                          javax.faces.context.FacesContext context,
                                                          boolean skipUnrendered)

Finds the first component by the given id expression or client id.

Parameters:

id - The id.

base - The base component to start the traversal.

separatorString - The seperatorString (e.g. :).

context - The FacesContext.

skipUnrendered - Defines if unrendered components should be skipped.

Returns:

The component or null.

closestForm

public static javax.faces.component.UIForm closestForm(javax.faces.context.FacesContext context,
                                                       javax.faces.component.UIComponent component)

closestUniqueIdVendor

public static javax.faces.component.UniqueIdVendor closestUniqueIdVendor(javax.faces.component.UIComponent component)

closestNamingContainer

public static javax.faces.component.UIComponent closestNamingContainer(javax.faces.component.UIComponent component)