Skip navigation links

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.UIXQuery

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

RichQuery, RichQuickQuery

public class UIXQuery

extends org.apache.myfaces.trinidad.component.UIXComponentBase

implements javax.faces.component.NamingContainer

Events:

Type	Phases	Description
oracle.adf.view.rich.event.QueryEvent	Invoke Application Apply Request Values	The Query event is delivered when a query action is triggered.
oracle.adf.view.rich.event.QueryOperationEvent	Invoke Application Apply Request Values	The QueryOperationEvent is generated for all operations performed on saved searches. These include creating, deleting, reseting and selecting a saved search.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Nested Class Summary

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.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONJUNCTION_READ_ONLY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MODEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUERY_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUERY_OPERATION_LISTENER_KEY
static java.lang.String	QUERY_REFRESH_LIST_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	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

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	UIXQuery() Construct an instance of the UIXQuery.
protected	UIXQuery(java.lang.String rendererType) Construct an instance of the UIXQuery.

Method Summary

void	addQueryListener(QueryListener listener) Adds a query listener.
void	addQueryOperationListener(QueryOperationListener listener) Adds a queryOperation listener.
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.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getFamily()
QueryModel	getModel() Gets a QueryModel object that collectively represents the entire model for the query component.
javax.el.MethodExpression	getQueryListener() Gets a method reference to a Querylistener.
QueryListener[]	getQueryListeners() Returns an array of attached query listeners.
javax.el.MethodExpression	getQueryOperationListener() Gets a method reference to a QueryOperationlistener
QueryOperationListener[]	getQueryOperationListeners() Returns an array of attached queryOperation listeners.
QueryDescriptor	getValue() Gets a QueryDescriptor object.
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
boolean	isConjunctionReadOnly() Gets whether the conjunction is readOnly or not
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	removeQueryListener(QueryListener listener) Removes a query listener.
void	removeQueryOperationListener(QueryOperationListener listener) Removes a queryOperation listener.
void	setConjunctionReadOnly(boolean conjunctionReadOnly) Sets whether the conjunction is readOnly or not
void	setModel(QueryModel model) Sets a QueryModel object that collectively represents the entire model for the query component.
void	setQueryListener(javax.faces.el.MethodBinding binding) Deprecated.
void	setQueryListener(javax.el.MethodExpression queryListener) Sets a method reference to a Querylistener.
void	setQueryOperationListener(javax.faces.el.MethodBinding binding) Deprecated.
void	setQueryOperationListener(javax.el.MethodExpression queryOperationListener) Sets a method reference to a QueryOperationlistener
void	setValue(QueryDescriptor value) Sets a QueryDescriptor object.

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

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

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

addPartialTarget, clearCachedClientIds, clearCachedClientIds, 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, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CONJUNCTION_READ_ONLY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONJUNCTION_READ_ONLY_KEY

VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY

MODEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_KEY

QUERY_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_LISTENER_KEY

QUERY_OPERATION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_OPERATION_LISTENER_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

QUERY_REFRESH_LIST_KEY

public static final java.lang.String QUERY_REFRESH_LIST_KEY

Constructor Detail

UIXQuery

public UIXQuery()

Construct an instance of the UIXQuery.

UIXQuery

protected UIXQuery(java.lang.String rendererType)

Construct an instance of the UIXQuery.

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,
                                 java.lang.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 java.io.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:

java.io.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

isConjunctionReadOnly

public final boolean isConjunctionReadOnly()

Gets whether the conjunction is readOnly or not

Returns:

the new conjunctionReadOnly value

setConjunctionReadOnly

public final void setConjunctionReadOnly(boolean conjunctionReadOnly)

Sets whether the conjunction is readOnly or not

Parameters:

conjunctionReadOnly - the new conjunctionReadOnly value

getValue

public final QueryDescriptor getValue()

Gets a QueryDescriptor object. This provides information about the currently selected saved search. For details about QueryDescriptor, please refer to oracle.adf.view.rich.model.QueryDescriptor

Returns:

the new value value

setValue

public final void setValue(QueryDescriptor value)

Sets a QueryDescriptor object. This provides information about the currently selected saved search. For details about QueryDescriptor, please refer to oracle.adf.view.rich.model.QueryDescriptor

Parameters:

value - the new value value

getModel

public final QueryModel getModel()

Gets a QueryModel object that collectively represents the entire model for the query component. The QueryModel manages QueryDescriptors, iow, supports methods to create, clone (from an existing), delete, reset and update a QueryDescriptor. For details about QueryModel, please refer to the Javadocs for oracle.adf.view.rich.model.QueryModel.

Returns:

the new model value

setModel

public final void setModel(QueryModel model)

Sets a QueryModel object that collectively represents the entire model for the query component. The QueryModel manages QueryDescriptors, iow, supports methods to create, clone (from an existing), delete, reset and update a QueryDescriptor. For details about QueryModel, please refer to the Javadocs for oracle.adf.view.rich.model.QueryModel.

Parameters:

model - the new model value

getQueryListener

public final javax.el.MethodExpression getQueryListener()

Gets a method reference to a Querylistener. The queryListener is called when the user preforms a search.

Returns:

the new queryListener value

setQueryListener

public final void setQueryListener(javax.el.MethodExpression queryListener)

Sets a method reference to a Querylistener. The queryListener is called when the user preforms a search.

Parameters:

queryListener - the new queryListener value

getQueryOperationListener

public final javax.el.MethodExpression getQueryOperationListener()

Gets a method reference to a QueryOperationlistener

Returns:

the new queryOperationListener value

setQueryOperationListener

public final void setQueryOperationListener(javax.el.MethodExpression queryOperationListener)

Sets a method reference to a QueryOperationlistener

Parameters:

queryOperationListener - the new queryOperationListener value

addQueryListener

public final void addQueryListener(QueryListener listener)

Adds a query listener.

Parameters:

listener - the query listener to add

removeQueryListener

public final void removeQueryListener(QueryListener listener)

Removes a query listener.

Parameters:

listener - the query listener to remove

getQueryListeners

public final QueryListener[] getQueryListeners()

Returns an array of attached query listeners.

Returns:

an array of attached query listeners.

addQueryOperationListener

public final void addQueryOperationListener(QueryOperationListener listener)

Adds a queryOperation listener.

Parameters:

listener - the queryOperation listener to add

removeQueryOperationListener

public final void removeQueryOperationListener(QueryOperationListener listener)

Removes a queryOperation listener.

Parameters:

listener - the queryOperation listener to remove

getQueryOperationListeners

public final QueryOperationListener[] getQueryOperationListeners()

Returns an array of attached queryOperation listeners.

Returns:

an array of attached queryOperation listeners.

getFamily

public java.lang.String getFamily()

Specified by:

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

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

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

Skip navigation links