|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
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
oracle.adf.view.rich.component.rich.RichQuickQuery
public class RichQuickQuery
The QuickQuery component enables a user to perform a quick search for a textual string against the selected criterion belonging to the QueryDescriptor as specified by the value property. The quickQuery component is a composite of other web components some rendered implicitly, others as specified by the facets of the component. The quickQuery component is usually used along with a table/treeTable component, that displays the results of the search. Developers can set the partialTriggers property of the the table component to the id of the quickQuery component, in order to see the results of the search, each time the user performs a query.
The following web components are generated as part of a quickQuery component.
Search Label is specified using the label property on the quickquery Component and it is displayed at the beginning of quickQuery component as per the specified layout.
This facet specifies a component that displays the list of criterion associated to the QueryDescriptor. Usually a select component is used for this purpose, but if the facet is not defined, a selectOneChoice component will be generated by default. Developers can use other components using this facet in which case they will be used in place of the selectOneChoice. Developers are responsible for wiring the value property to a valid QueryDescriptor instance and register a QueryListener that performs the query.
Based on the criterion that is currently selected in the criteriaItems select component, a value component, appropriate for the type of the criterion, is dynamically rendered. For e.g., if the criterion selected happens to be of type Date, an inputDate component is rendered. A type Number yields a inputNumberSpinbox. For more information on how this is determined, refer to the QueryDescriptor, ConjunctionCriterion, AttributeCriterion and AttributeDescriptor model interfaces.
User enters a value that will be used in the search criteria.
A Search icon link that allows the user to perform the search against the selected criterion using the value entered in the value component. This button will be made disabled if the descriptor is null (iow, 'value' property resolves to null) and no 'criterionValue' facet is specified, or if criteriaItems resolves to null.
This facet usually specifies a commandLink component that is used to toggle between quickQuery and query component.
The following example explains the usage of quickQuery Component.
<af:quickQuery label="Search" id="search" value="bean.queryDescriptor" queryListener="bean.processQuery"> <f:facet name="end"> <af:commandLink text="Advanced"/> </f:facet> </af:quickQuery>
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 |
---|
Nested classes/interfaces inherited from class oracle.adf.view.rich.component.UIXQuery |
---|
UIXQuery.InternalQueryBean |
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static java.lang.String |
CRITERIA_ITEMS_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static java.lang.String |
END_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TOPIC_ID_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LABEL_KEY |
static java.lang.String |
LAYOUT_HORIZONTAL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LAYOUT_KEY |
static java.lang.String |
LAYOUT_VERTICAL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SEARCH_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Fields inherited from class oracle.adf.view.rich.component.UIXQuery |
---|
CONJUNCTION_READ_ONLY_KEY, MODEL_KEY, QUERY_LISTENER_KEY, QUERY_OPERATION_LISTENER_KEY, QUERY_REFRESH_LIST_KEY, 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 | |
---|---|
|
RichQuickQuery() Construct an instance of the RichQuickQuery. |
protected |
RichQuickQuery(java.lang.String rendererType) Construct an instance of the RichQuickQuery. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
javax.faces.component.UIComponent |
getCriteriaItems() The component used to display a list of criterion. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
javax.faces.component.UIComponent |
getEnd() The component to be displayed at the end of the quickQuery component. |
java.lang.String |
getFamily() |
java.lang.String |
getHelpTopicId() Gets the id used to look up a topic in a helpProvider. |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String |
getLabel() Gets the label of the quickQuery. |
java.lang.String |
getLayout() Gets the type of layout. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getSearchDesc() Gets the search description of the component. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.util.Set<java.lang.String> |
getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isVisible() Gets the visibility of the component. |
void |
setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names. |
void |
setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated. |
void |
setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners. |
void |
setCriteriaItems(javax.faces.component.UIComponent criteriaItemsFacet) The component used to display a list of criterion. |
void |
setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setEnd(javax.faces.component.UIComponent endFacet) The component to be displayed at the end of the quickQuery component. |
void |
setHelpTopicId(java.lang.String helpTopicId) Sets the id used to look up a topic in a helpProvider. |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setLabel(java.lang.String label) Sets the label of the quickQuery. |
void |
setLayout(java.lang.String layout) Sets the type of layout. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setSearchDesc(java.lang.String searchDesc) Sets the search description of the component. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
void |
setVisible(boolean visible) Sets the visibility of the component. |
Methods inherited from class oracle.adf.view.rich.component.UIXQuery |
---|
addQueryListener, addQueryOperationListener, broadcast, decodeChildrenImpl, encodeBegin, getModel, getQueryListener, getQueryListeners, getQueryOperationListener, getQueryOperationListeners, getValue, invokeOnComponent, isConjunctionReadOnly, queueEvent, refresh, removeQueryListener, removeQueryOperationListener, setConjunctionReadOnly, setModel, setQueryListener, setQueryListener, setQueryOperationListener, setQueryOperationListener, setValue |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, 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, 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 java.lang.String LAYOUT_HORIZONTAL
public static final java.lang.String LAYOUT_VERTICAL
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LAYOUT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SEARCH_DESC_KEY
public static final java.lang.String CRITERIA_ITEMS_FACET
public static final java.lang.String END_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichQuickQuery()
protected RichQuickQuery(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getCriteriaItems()
public final void setCriteriaItems(javax.faces.component.UIComponent criteriaItemsFacet)
public final javax.faces.component.UIComponent getEnd()
public final void setEnd(javax.faces.component.UIComponent endFacet)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String getLabel()
public final void setLabel(java.lang.String label)
label
- the new label valuepublic final java.lang.String getHelpTopicId()
public final void setHelpTopicId(java.lang.String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final java.lang.String getLayout()
public final void setLayout(java.lang.String layout)
layout
- the new layout valuepublic final java.lang.String getSearchDesc()
public final void setSearchDesc(java.lang.String searchDesc)
searchDesc
- the new searchDesc valuepublic java.lang.String getFamily()
getFamily
in class UIXQuery
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXQuery
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |