oracle.adf.view.rich.component

Class UIXQuery

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

oracle.adf.view.rich.component.PartialUIXQuery

oracle.adf.view.rich.component.UIXQuery

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

RichQuery, RichQuickQuery

public class UIXQuery
extends PartialUIXQuery

Base class for Dialog component.

Version:

$Name: $ ($Revision: 429530 $) $Date: 2006-08-07 17:44:54 -0700 (Mon, 07 Aug 2006) $

Author:

The Oracle ADF Faces Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIXQuery.InternalQueryBean This class is used internally by the query component to setup ValueExpressions for its 'value' and 'model' properties when none is provided.

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERY_REFRESH_LIST_KEY

Fields inherited from class oracle.adf.view.rich.component.PartialUIXQuery

COMPONENT_FAMILY, COMPONENT_TYPE, CONJUNCTION_READ_ONLY_KEY, MODEL_KEY, QUERY_LISTENER_KEY, QUERY_OPERATION_LISTENER_KEY, TYPE, VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

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

Modifier	Constructor and Description
	UIXQuery() Construct an instance of the UIXQuery.
protected	UIXQuery(String rendererType) Construct an instance of the AbstractUIXQuery.

Method Summary

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
protected void	decodeChildrenImpl(javax.faces.context.FacesContext context) Calls processDecodes on all facets and children of this component.This method is overrided to set up ValueExpressions for the value and model properties of the query component, when there are none setup.
void	encodeBegin(javax.faces.context.FacesContext context) This method is overrided to set up ValueExpressions for the value and model properties of the query component, when there are none setup.
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
void	queueEvent(javax.faces.event.FacesEvent e)
void	refresh(javax.faces.context.FacesContext context) This method should be called when the model definition changes and the query component needs to be refreshed (iow, all its children removed and recreated).
void	setQueryListener(javax.faces.el.MethodBinding binding) Deprecated.
void	setQueryOperationListener(javax.faces.el.MethodBinding binding) Deprecated.

Methods inherited from class oracle.adf.view.rich.component.PartialUIXQuery

addQueryListener, addQueryOperationListener, getBeanType, getFamily, getModel, getQueryListener, getQueryListeners, getQueryOperationListener, getQueryOperationListeners, getValue, isConjunctionReadOnly, removeQueryListener, removeQueryOperationListener, setConjunctionReadOnly, setModel, setQueryListener, setQueryOperationListener, setValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_REFRESH_LIST_KEY

public static final String QUERY_REFRESH_LIST_KEY

Constructor Detail

UIXQuery

public UIXQuery()

Construct an instance of the UIXQuery.

UIXQuery

protected UIXQuery(String rendererType)

Construct an instance of the AbstractUIXQuery.

Parameters:

rendererType - the renderer type.

Method Detail

setQueryListener

@Deprecated
public void setQueryListener(javax.faces.el.MethodBinding binding)

Deprecated.

setQueryOperationListener

@Deprecated
public void setQueryOperationListener(javax.faces.el.MethodBinding binding)

Deprecated.

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.FacesException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException

This method is overrided to set up ValueExpressions for the value and model properties of the query component, when there are none setup. This is likely to happen when the query component is setup programmatically and property values provided through the setters.

Overrides:

encodeBegin in class org.apache.myfaces.trinidad.component.UIXComponentBase

Parameters:

context - the FacesContext

Throws:

IOException

refresh

public void refresh(javax.faces.context.FacesContext context)

This method should be called when the model definition changes and the query component needs to be refreshed (iow, all its children removed and recreated).
For example, when a new criterion is added to the QueryDescriptor or an existing one removed, if the underlying model returns a different collection of criterion objects than what the component sub-tree expects, then this method should be called. This method internally marks the query as requiring a refresh by adding the client id of this component to the refresh list, which will be used to refresh the query component at the end of Invoke Application phase and sub-tree for this query component will be removed. This method has no effect when called during PhaseId.RENDER_RESPONSE phase.

Parameters:

context - the FacesContext

decodeChildrenImpl

protected void decodeChildrenImpl(javax.faces.context.FacesContext context)

Calls processDecodes on all facets and children of this component.This method is overrided to set up ValueExpressions for the value and model properties of the query component, when there are none setup. This is likely to happen when the query component is setup programmatically and property values provided through the setters.

Overrides:

decodeChildrenImpl in class org.apache.myfaces.trinidad.component.UIXComponentBase

Parameters:

context - the current FacesContext