|Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
11g Release 2 (220.127.116.11.0)
UIComponent class: oracle.adf.view.rich.component.rich.RichQuickQuery
Component type: oracle.adf.RichQuickQuery
Naming container: Yes. When referring to children of this component ("partialTriggers",
findComponent(), etc.), you must prefix the child's ID with this component's ID and a colon (':')
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>
Apply Request Values
|The Query event is delivered when a query action is triggered.|
Apply Request Values
|The QueryOperationEvent is generated for all operations performed on saved searches. These include creating, deleting, reseting and selecting a saved search.|
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.|
|criteriaItems||The component used to display a list of criterion. A select component can be specified and by default, if a criteriaItems facet is not defined, a selectOneChoice component is created. A quick search is performed against one of the criterion, using the values entered in "a dynamically generated" value component. Must be only one component, multiple components are not supported by this facet.|
|end||The component to be displayed at the end of the quickQuery component. For e.g., it is used to display a commandLink that toggles between quickQuery and query components, when component is configured using ADF-DT. Must be only one component, multiple components are not supported by this facet.|
|attributeChangeListener||javax.el.MethodExpression||Only EL||a method reference to an attribute change listener. 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.|
|binding||oracle.adf.view.rich.component.rich.RichQuickQuery||Only EL||an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.|
|clientComponent||boolean||Yes||Default Value: false
|conjunctionReadOnly||boolean||Yes||Default Value: false
whether the conjunction is readOnly or not
|customizationId||String||Yes||This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.|
|helpTopicId||String||Yes||the id used to look up a topic in a helpProvider.|
|id||String||No||the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|inlineStyle||String||Yes||the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.|
|label||String||Yes||the label of the quickQuery.|
|layout||String||Yes||Valid Values: horizontal, vertical
Default Value: horizontal
the type of layout.
|model||oracle.adf.view.rich.model.QueryModel||Yes||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.|
|partialTriggers||String||Yes||the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.|
|queryListener||javax.el.MethodExpression||Only EL||a method reference to a Querylistener. The queryListener is called when the user preforms a search.|
|queryOperationListener||javax.el.MethodExpression||Only EL||a method reference to a QueryOperationlistener|
|rendered||boolean||Yes||Default Value: true
whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
|searchDesc||String||Yes||used to override the search description. The search description appears in the tooltip when user does a mouseover on the Search icon. By default this value will be 'Search: ' followed by the label name. If a searchDesc is specified, that value is used instead.|
|shortDesc||String||Yes||the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.|
|styleClass||String||Yes||a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.|
|value||oracle.adf.view.rich.model.QueryDescriptor||Yes||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|
|visible||boolean||Yes||Default Value: true
the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core