# JavaScript API Reference for Oracle ADF Faces

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

# oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfSingleSelectInputSearchPeer

## Warning:

- This is an unsupported, internal implementation class.
- Use an API class that might provide equivalent functionality instead.
- This class will change without notice.
- It is not recommended that you use anything in this class.

    org.ecmascript.object.Object
       |
       +--oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlInputSearchPeer
             |
             +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfSingleSelectInputSearchPeer

    public class AdfSingleSelectInputSearchPeer
    extends AdfDhtmlInputSearchPeer

Stateful Peer for single select InputSearch component

## Field Summary
`private static Object` | `_AUTOCOMPLETE_ANNOUNCE_MSG`
`private static Object` | `_MSG_AUTCOMPLETE_FAILED_DETAIL`
`private static Object` | `_MSG_AUTOCOMPLETE_FAILED`
`private Object` | `_suggestionsPanel`

### Fields inherited from org.ecmascript.object.Object
`constructor, prototype`

## Constructor Summary
`public` | `AdfSingleSelectInputSearchPeer()` Stateful Peer for single select InputSearch component

## Method Summary
`private Object` | `_autoComplete(Object component)` Attempt to autoComplete the input element value
`protected Object` | `ClearTemporaryStorage()`
`public Object` | `delayedHandleAutoCompletingEvent(AdfAutoCompletingEvent componentEvent)` Manages auto-completion post the broadcast of AdfAutoCompletingEvent This method is invoked from the component
`protected Object` | `GetCombinedDisplayValue(Object newValues)`
`protected Object` | `GetDisplayValue(Object component, Object domElement, Object unconditional)` Override to return an array, as inputSearch also supports multi-selection
`protected Object` | `GetRealNewValues(Object newValues, Object oldValues)`
`protected Object` | `GetSuggestionMapContainingSelections(Object newValues)` Returns an instance of {AdfSuggestionMapInterface} from where suggestion objects can be retrieved for the selected values.
`protected Object` | `GetSuggestionsPanel()`
`protected Object` | `InitDomElement(Object component, Object element)`
`protected static Object` | `InitSubclass()`
`private static Object` | `_isDisplayValueUpdatePossible(Object component, Object domElement, Object suggestionMap, Object values)` Returns true if the display value can/need to be updated
`protected Object` | `IsUnderAutocompletion()`
`protected Object` | `RenderSelections(Object component)` Will only be invoked for multi-select inputSearch to display the selections
`protected Object` | `RestoreSelectionOnEscape(Object component, Object domElement, Object contentNode)` In single selection mode, pressing Escape key means close the suggestions popup and restore the original selection back.
`protected Object` | `RunValidation(Object component, Object targetNode, Object isChangeRequired)`
`Object` | `__setComponentValue(Object component, Object newValue)` Sets the component value from the supplied selected item
`protected Object` | `SetDisplayValueOnPrefetch(Object component, Object suggestions, Object isMasterList)`
`protected Object` | `ShowSelectionsPopup(Object component, Object contentNode)` Will only be invoked for multi-select inputSearch to display the selections
`protected Object` | `ToggleDisplayValueToFiltering(Object contentNode, Object keyCode)`
`protected Object` | `UpdateDisplayValueAndSelection(Object component, Object domElement, Object values, Object freshSuggestions, Object isMasterList)` Invoked if there is a potential chance if a selection has happended from preferred suggestions
`protected Object` | `Validate(Object component, Object submittedValue)` Attempts to autoComplete the submittedValue

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlInputSearchPeer
`GetBestMatchSubId, GetSubIdDomElement`

## Field Detail

### _AUTOCOMPLETE_ANNOUNCE_MSG

`private static Object _AUTOCOMPLETE_ANNOUNCE_MSG`

### _MSG_AUTCOMPLETE_FAILED_DETAIL

`private static Object _MSG_AUTCOMPLETE_FAILED_DETAIL`

### _MSG_AUTOCOMPLETE_FAILED

`private static Object _MSG_AUTOCOMPLETE_FAILED`

### _suggestionsPanel

`private Object _suggestionsPanel`

## Constructor Detail

### AdfSingleSelectInputSearchPeer

`public AdfSingleSelectInputSearchPeer()`
  Stateful Peer for single select InputSearch component

## Method Detail

### _autoComplete

`private Object _autoComplete(Object component)`
  Attempt to autoComplete the input element value
  Parameters:

    `component` |  |

  Return:
    `Object` - Returns autoCompleted value or null

### ClearTemporaryStorage

`protected Object ClearTemporaryStorage()`
  Return:
    `Object`

### delayedHandleAutoCompletingEvent

`public Object delayedHandleAutoCompletingEvent(AdfAutoCompletingEvent componentEvent)`
  Manages auto-completion post the broadcast of AdfAutoCompletingEvent This method is invoked from the component
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### GetCombinedDisplayValue

`protected Object GetCombinedDisplayValue(Object newValues)`
  Parameters:

    `newValues` |  |

  Return:
    `Object`

### GetDisplayValue

`protected Object GetDisplayValue(Object component,
Object domElement,
Object unconditional)`
  Override to return an array, as inputSearch also supports multi-selection
  Parameters:

    `component` |  |
    `domElement` |  |
    `unconditional` |  |

  Return:
    `Object`

### GetRealNewValues

`protected Object GetRealNewValues(Object newValues,
Object oldValues)`
  Parameters:

    `newValues` |  |
    `oldValues` |  |

  Return:
    `Object`

### GetSuggestionMapContainingSelections

`protected Object GetSuggestionMapContainingSelections(Object newValues)`
  Returns an instance of {AdfSuggestionMapInterface} from where suggestion objects can be retrieved for the selected values.
  Parameters:

    `newValues` |  |

  Return:
    `Object`

### GetSuggestionsPanel

`protected Object GetSuggestionsPanel()`
  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(Object component,
Object element)`
  Parameters:

    `component` |  |
    `element` |  |

  Return:
    `Object`

### InitSubclass

`protected static Object InitSubclass()`
  Return:
    `Object`

### _isDisplayValueUpdatePossible

`private static Object _isDisplayValueUpdatePossible(Object component,
Object domElement,
Object suggestionMap,
Object values)`
  Returns true if the display value can/need to be updated
  Parameters:

    `component` |  |
    `domElement` |  |
    `suggestionMap` |  |
    `values` |  |

  Return:
    `Object`

### IsUnderAutocompletion

`protected Object IsUnderAutocompletion()`
  Return:
    `Object`

### RenderSelections

`protected Object RenderSelections(Object component)`
  Will only be invoked for multi-select inputSearch to display the selections
  Parameters:

    `component` |  |

  Return:
    `Object`

### RestoreSelectionOnEscape

`protected Object RestoreSelectionOnEscape(Object component,
Object domElement,
Object contentNode)`
  In single selection mode, pressing Escape key means close the suggestions popup and restore the original selection back. Kind of an undo operation.
  Parameters:

    `component` |  |
    `domElement` |  |
    `contentNode` |  |

  Return:
    `Object`

### RunValidation

`protected Object RunValidation(Object component,
Object targetNode,
Object isChangeRequired)`
  Parameters:

    `component` |  |
    `targetNode` |  |
    `isChangeRequired` |  |

  Return:
    `Object`

### __setComponentValue

`Object __setComponentValue(Object component,
Object newValue)`
  Sets the component value from the supplied selected item
  Parameters:

    `component` |  |
    `newValue` |  |

  Return:
    `Object`

### SetDisplayValueOnPrefetch

`protected Object SetDisplayValueOnPrefetch(Object component,
Object suggestions,
Object isMasterList)`
  Parameters:

    `component` |  |
    `suggestions` |  |
    `isMasterList` |  |

  Return:
    `Object`

### ShowSelectionsPopup

`protected Object ShowSelectionsPopup(Object component,
Object contentNode)`
  Will only be invoked for multi-select inputSearch to display the selections
  Parameters:

    `component` |  |
    `contentNode` |  |

  Return:
    `Object`

### ToggleDisplayValueToFiltering

`protected Object ToggleDisplayValueToFiltering(Object contentNode,
Object keyCode)`
  Parameters:

    `contentNode` |  |
    `keyCode` |  |

  Return:
    `Object`

### UpdateDisplayValueAndSelection

`protected Object UpdateDisplayValueAndSelection(Object component,
Object domElement,
Object values,
Object freshSuggestions,
Object isMasterList)`
  Invoked if there is a potential chance if a selection has happended from preferred suggestions
  Parameters:

    `component` |  |
    `domElement` |  |
    `values` |  |
    `freshSuggestions` |  |
    `isMasterList` |  |

  Return:
    `Object`

### Validate

`protected Object Validate(Object component,
Object submittedValue)`
  Attempts to autoComplete the submittedValue
  Parameters:

    `component` |  |
    `submittedValue` |  |

  Return:
    `Object`

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.