Components.ForEach (OmniFaces 2.0 API)

java.lang.Object
- org.omnifaces.util.Components.ForEach

Enclosing class:

Components
```
public static class Components.ForEach
extends Object
```
Builder class used to collect a number of query parameters for a visit (for each) of components in the JSF component tree. The chain of collecting parameters is terminated by calling one of the invoke methods.

Since:

2.0

Author:

Arjan Tijms

Constructor Summary

Constructors
Constructor and Description

Components.ForEach()

Components.ForEach(FacesContext facesContext)

Constructors
Constructor and Description
`Components.ForEach()`
`Components.ForEach(FacesContext facesContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`Components.ForEach`	`fromRoot(UIComponent root)` The root component where tree visiting starts
`protected FacesContext`	`getFacesContext()`
`protected Set<VisitHint>`	`getHints()`
`protected Collection<String>`	`getIds()`
`protected UIComponent`	`getRoot()`
`Components.ForEach`	`havingIds(Collection<String> ids)` The IDs of the components that are visited
`Components.ForEach`	`havingIds(String... ids)` The IDs of the components that are to be visited
`void`	`invoke(Callback.ReturningWithArgument<VisitResult,UIComponent> operation)` Invokes the given operation on the components as specified by the query parameters set via this builder.
`void`	`invoke(Callback.WithArgument<UIComponent> operation)` Invokes the given operation on the components as specified by the query parameters set via this builder.
`void`	`invoke(VisitCallback operation)` Invokes the given operation on the components as specified by the query parameters set via this builder.
`Components.ForEach`	`ofTypes(Class<?>... types)` The types of the components that are to be visited
`Components.ForEach`	`withHints(Set<VisitHint> hints)` The VisitHints that are used for the visit.
`Components.ForEach`	`withHints(VisitHint... hints)` The VisitHints that are used for the visit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Components.ForEach
```
public Components.ForEach()
```
  - Components.ForEach
```
public Components.ForEach(FacesContext facesContext)
```
- Method Detail
  - fromRoot
```
public Components.ForEach fromRoot(UIComponent root)
```
    The root component where tree visiting starts
    
    Parameters:
    root - the root component where tree visiting starts
    
    Returns:
    the intermediate builder object to continue the builder chain
  - havingIds
```
public Components.ForEach havingIds(Collection<String> ids)
```
    The IDs of the components that are visited
    
    Parameters:
    ids - the IDs of the components that are visited
    
    Returns:
    the intermediate builder object to continue the builder chain
  - havingIds
```
public Components.ForEach havingIds(String... ids)
```
    The IDs of the components that are to be visited
    
    Parameters:
    ids - the IDs of the components that are to be visited
    
    Returns:
    the intermediate builder object to continue the builder chain
  - withHints
```
public Components.ForEach withHints(Set<VisitHint> hints)
```
    The VisitHints that are used for the visit.
    
    Parameters:
    hints - the VisitHints that are used for the visit.
    
    Returns:
    the intermediate builder object to continue the builder chain
  - withHints
```
public Components.ForEach withHints(VisitHint... hints)
```
    The VisitHints that are used for the visit.
    
    Parameters:
    hints - the VisitHints that are used for the visit.
    
    Returns:
    the intermediate builder object to continue the builder chain
  - ofTypes
```
@SafeVarargs
public final Components.ForEach ofTypes(Class<?>... types)
```
    The types of the components that are to be visited
    
    Parameters:
    types - the types of the components that are to be visited
    
    Returns:
    the intermediate builder object to continue the builder chain
  - invoke
```
public void invoke(Callback.WithArgument<UIComponent> operation)
```
    Invokes the given operation on the components as specified by the query parameters set via this builder.
    
    Parameters:
    operation - the operation to invoke on each component
  - invoke
```
public void invoke(Callback.ReturningWithArgument<VisitResult,UIComponent> operation)
```
    Invokes the given operation on the components as specified by the query parameters set via this builder.
    
    Parameters:
    operation - the operation to invoke on each component
  - invoke
```
public void invoke(VisitCallback operation)
```
    Invokes the given operation on the components as specified by the query parameters set via this builder.
    
    Parameters:
    operation - the operation to invoke on each component
  - getFacesContext
```
protected FacesContext getFacesContext()
```
  - getRoot
```
protected UIComponent getRoot()
```
  - getIds
```
protected Collection<String> getIds()
```
  - getHints
```
protected Set<VisitHint> getHints()
```

Class Components.ForEach

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Components.ForEach

Components.ForEach

Method Detail

fromRoot

havingIds

havingIds

withHints

withHints

ofTypes

invoke

invoke

invoke

getFacesContext

getRoot

getIds

getHints