JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlQuickQueryPeer

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlQuickQueryPeer

public class AdfDhtmlQuickQueryPeer
extends AdfRichUIPeer

_SEARCH_ICON_ID

private static Object _SEARCH_ICON_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

quickQuery component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [criteria_items --> criteriaItems] - criteria items 2. [criterion_value --> criterionValue] - criterion Value 3. [search_icon --> search_icon] - search icon If a subId is not contained in the map below, it's corresponding DOM is located programmatically in AdfDhtmlQuickQueryPeer.GetSubIdDomElement().

AdfDhtmlQuickQueryPeer

public AdfDhtmlQuickQueryPeer()

make AdfDhtmlQuickQueryPeer a subclass of AdfRichUIPeer

GetBestMatchSubId

protected Object GetBestMatchSubId(Object domElement)

Returns the best match subId for the given domElement. This can be enhanced further to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

domElement

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

Overrides:

AdfRichUIPeer.GetBestMatchSubId(Object)

_getNestedComponentSubId

private Object _getNestedComponentSubId(Object nestedComponentClientId,
                                        Object domElement,
                                        Object nestedSubId)

Parameters:

nestedComponentClientId
domElement
nestedSubId

Return:

Object

_getNestedSubIdIndex

private Object _getNestedSubIdIndex(Object clientId,
                                    Object subClientId)

Parameters:

clientId
subClientId

Return:

Object

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(Object subElementIdLocator)

Returns the dom element for a given subElementId for quickQuery.

Parameters:

subElementIdLocator

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

HandleComponentClick

protected Object HandleComponentClick(AdfComponentEvent componentEvent)

Handle the Component click when user clicks on search Icon and add as the queryEvent

Parameters:

componentEvent

Return:

Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

When quickQuery component is used inside a dialog and the Enter key pressed, keydown event bubbles up to the dialog potentially causing it to close, especially if the dialog has an OK outcome. Canceling the keydown event, when it is not consumed by any of the subcomponents of the quickQuery does, is therefore required.

Parameters:

componentEvent

-

the component event generated by enter key down.

Return:

Object

See also:

"AdfDhtmlDialogPeer#HandleComponentKeyDown"

HandleComponentKeyPress

protected Object HandleComponentKeyPress(Object componentEvent)

When quickQuery component is used inside a dialog and the Enter key pressed, keydown event bubbles up to the dialog potentially causing it to close, especially if the dialog has an OK outcome. Canceling the keydown event, when it is not consumed by any of the subcomponents of the quickQuery does, is therefore required.

Parameters:

componentEvent

-

the component event generated by enter key press.

Return:

Object

See also:

"AdfDhtmlDialogPeer#HandleComponentKeyPress"

HandleComponentKeyUp

protected Object HandleComponentKeyUp(AdfComponentEvent componentEvent)

Component key up handler that processes the enter key event and queues a QueryEvent except if the sub-component consumes it. - Enter on the Go button should not queue a second QueryEvent, as the click event (generated in addition to key events) would have already queued it. - Enter on the Advanced link should not queue a QueryEvent - In general if the component consumes the Enter key (such autoSubmit components) the QueryEvent should not additionally queued.

Parameters:

componentEvent

Return:

Object

InitSubclass

protected static Object InitSubclass()

Initialize the peer class

Return:

Object

_isEnterKeyNotConsumed

private Boolean _isEnterKeyNotConsumed(Object componentEvent)

Return true if Enter key is pressed on a component that does not consume it else return false. We need to track the cases where Enter key actually means something to the native target: a. when focus is in a textarea (inserts a new line) b. when focus is on an anchor (executes a command or is a GET) c. when focus is on a button (input type=button, input type=submit, input type=reset, or plain button) d. when the key event has been canceled specifically by another component/peer (e.g. there may be other input components that want to cancel this key and prevent executing a search. Outside of the above special cases is the Enter key is pressed on a component that does not consume it , then return false.

Parameters:

componentEvent

-

the component event

Return:

Boolean - true if Enter key is pressed on a component that does not consume it