|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class UIXQuery
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 events 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 |
---|
bindings |
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, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, 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, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONJUNCTION_READ_ONLY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_OPERATION_LISTENER_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String QUERY_REFRESH_LIST_KEY
Constructor Detail |
---|
public UIXQuery()
protected UIXQuery(java.lang.String rendererType)
Method Detail |
---|
@Deprecated
public void setQueryListener(javax.faces.el.MethodBinding binding)
@Deprecated
public void setQueryOperationListener(javax.faces.el.MethodBinding binding)
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
invokeOnComponent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.FacesException
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class org.apache.myfaces.trinidad.component.UIXComponentBase
context
- the FacesContextjava.io.IOException
public void refresh(javax.faces.context.FacesContext context)
PhaseId.RENDER_RESPONSE
phase.context
- the FacesContextprotected void decodeChildrenImpl(javax.faces.context.FacesContext context)
decodeChildrenImpl
in class org.apache.myfaces.trinidad.component.UIXComponentBase
context
- the current FacesContextpublic final boolean isConjunctionReadOnly()
public final void setConjunctionReadOnly(boolean conjunctionReadOnly)
conjunctionReadOnly
- the new conjunctionReadOnly valuepublic final QueryDescriptor getValue()
public final void setValue(QueryDescriptor value)
value
- the new value valuepublic final QueryModel getModel()
public final void setModel(QueryModel model)
model
- the new model valuepublic final javax.el.MethodExpression getQueryListener()
public final void setQueryListener(javax.el.MethodExpression queryListener)
queryListener
- the new queryListener valuepublic final javax.el.MethodExpression getQueryOperationListener()
public final void setQueryOperationListener(javax.el.MethodExpression queryOperationListener)
queryOperationListener
- the new queryOperationListener valuepublic final void addQueryListener(QueryListener listener)
listener
- the query listener to addpublic final void removeQueryListener(QueryListener listener)
listener
- the query listener to removepublic final QueryListener[] getQueryListeners()
public final void addQueryOperationListener(QueryOperationListener listener)
listener
- the queryOperation listener to addpublic final void removeQueryOperationListener(QueryOperationListener listener)
listener
- the queryOperation listener to removepublic final QueryOperationListener[] getQueryOperationListeners()
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |