org.omnifaces.component.util

Class ResolveComponent

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.omnifaces.component.util.UtilFamily

org.omnifaces.component.util.ResolveComponent

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListener, SystemEventListenerHolder, FaceletContextConsumer

public class ResolveComponent
extends UtilFamily
implements FaceletContextConsumer, SystemEventListener

The <o:resolveComponent> component is a utility component via which a component can be looked up by its ID and a reference to it put in either the "facelet scope" (default) or the request scope.

Since:

2.0

Author:

Arjan Tijms

See Also:

FaceletContextConsumer, ComponentExtraHandler, UtilFamily

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolveComponent.ComponentClientIdResolver

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	DEFAULT_SCOPE

Fields inherited from class org.omnifaces.component.util.UtilFamily

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
ResolveComponent()

Method Summary

Modifier and Type	Method and Description
void	doProcess()
String	getFor()
String	getName()
String	getScope()
boolean	isListenerForSource(Object source)
void	processEvent(ComponentSystemEvent event)
void	processEvent(SystemEvent event)
void	setFaceletContext(FaceletContext faceletContext)
void	setFor(String nameValue)
void	setName(String nameValue)
void	setScope(String scopeValue)

Methods inherited from class org.omnifaces.component.util.UtilFamily

getFamily, getRendersChildren

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

Constant Field Values

Constructor Detail

ResolveComponent

public ResolveComponent()

Method Detail

setFaceletContext

public void setFaceletContext(FaceletContext faceletContext)

Specified by:

setFaceletContext in interface FaceletContextConsumer

isListenerForSource

public boolean isListenerForSource(Object source)

Specified by:

isListenerForSource in interface SystemEventListener

processEvent

public void processEvent(SystemEvent event)
                  throws AbortProcessingException

Specified by:

processEvent in interface SystemEventListener

Throws:

AbortProcessingException

processEvent

public void processEvent(ComponentSystemEvent event)
                  throws AbortProcessingException

Specified by:

processEvent in interface ComponentSystemEventListener

Overrides:

processEvent in class UIComponent

Throws:

AbortProcessingException

doProcess

public void doProcess()

getName

public String getName()

setName

public void setName(String nameValue)

getFor

public String getFor()

setFor

public void setFor(String nameValue)

getScope

public String getScope()

setScope

public void setScope(String scopeValue)