# 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 AdfMultiSelectInputSearchPeer

## 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.AdfMultiSelectInputSearchPeer

    public class AdfMultiSelectInputSearchPeer
    extends AdfDhtmlInputSearchPeer

Stateful Peer for multi select InputSearch component

## Field Summary
`private static Object` | `_DISPLAY_VALUE_SEPARATOR`
`static Object` | `__HAS_SELECTIONS_STATE_STYLE_CLASS`
`static Object` | `__SELECTIONS_LENGTH_EXPANDO`
`private Object` | `_suggestionsPanel`

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

## Constructor Summary
`public` | `AdfMultiSelectInputSearchPeer()` Stateful Peer for multi select InputSearch component

## Method Summary
`private Object` | `_createLocalSelections(Object component)` Local Selection is a Map of value --> row object map.
`protected Object` | `DerivePropsFromPrefSuggestions(Object component, Object preferredSuggestions)`
`Object` | `__fetchSpecificSuggestionsComplete(Object component, Object suggestions)`
`protected Object` | `GetCombinedDisplayValue(Object newValues)`
`protected Object` | `GetDisplayValue(Object component, Object domElement, Object unconditional)` Override to support multi-selection
`Object` | `__getLocalSelections()` Returns an object with values as key, and suggestionObjs as value.
`protected Object` | `GetReadyState()` Works in tandem with registerLoadingComponent and unregisterLoadingComponent calls done in this peer.
`protected Object` | `GetRealNewValues(Object newValues, Object oldValues)` Useful in multi-selection scenario to determine which among the current selections are new selections.
`private static Object` | `_getSelectionForValue(Object value, Object selections)`
`protected Object` | `GetSuggestionMapContainingSelections(Array newValues)` Returns an instance of {AdfSuggestionMapInterface} from where suggestion objects can be retrieved for the selected values.
`protected Object` | `GetSuggestionsPanel()`
`private Object` | `_getUnresolvedValues(Object component)`
`private Object` | `_hasUnresolvedValues(Object component)`
`protected Object` | `InitDomElement(Object component, Object element)`
`protected static Object` | `InitSubclass()`
`protected Object` | `IsUnderAutocompletion()`
`protected Object` | `PrefetchComplete(Object component, Object suggestions, Object isListComprehensive)`
`protected Object` | `RenderSelections(Object component)` Renders the selections list
`Object` | `__resolveLocalSelections(AdfRichInputSearch component, AdfSuggestionMap suggestions)` If there are any more values for which the entire suggestion obj needs to be retrieved, do it here.
`protected Object` | `RestoreSelectionOnEscape(Object component, Object domElement, Object contentNode)`
`protected Object` | `RunValidation(Object component, Object contentNode, Object isChangeRequired)` Invoked from popup closed handler.
`private Object` | `_selectionSeedingComplete(Object component)`
`private static Object` | `_setSelectionsCount(Object component, Object element, Object size)`
`protected Object` | `ShowSelectionsPopup(Object component, Object contentNode)`
`protected Object` | `ToggleDisplayValueToFiltering(Object contentNode, Object keyCode)` Prepares the contentNode to enable filtering.
`protected Object` | `UpdateDisplayValueAndSelection(Object component, Object domElement, Object values, Object freshSuggestions)` Invoked if there is a potential chance if a selection has happended from preferred suggestions
`private Object` | `_updateLocalSelections(Object newValues, Object oldLocalSelections, Object displayedSuggestions)`
`private static Object` | `_updateSelectionsCount(Object component, Object element, Object size)`

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

## Field Detail

### _DISPLAY_VALUE_SEPARATOR

`private static Object _DISPLAY_VALUE_SEPARATOR`

### __HAS_SELECTIONS_STATE_STYLE_CLASS

`static Object __HAS_SELECTIONS_STATE_STYLE_CLASS`

### __SELECTIONS_LENGTH_EXPANDO

`static Object __SELECTIONS_LENGTH_EXPANDO`

### _suggestionsPanel

`private Object _suggestionsPanel`

## Constructor Detail

### AdfMultiSelectInputSearchPeer

`public AdfMultiSelectInputSearchPeer()`
  Stateful Peer for multi select InputSearch component

## Method Detail

### _createLocalSelections

`private Object _createLocalSelections(Object component)`
  Local Selection is a Map of value --> row object map. Local selections uses ordered map to ensure the order of selections is maintained. Though ordering is not important for the component, but for the UI it is better we preserve the order for better UX.
  Parameters:

    `component` |  |

  Return:
    `Object`

### DerivePropsFromPrefSuggestions

`protected Object DerivePropsFromPrefSuggestions(Object component,
Object preferredSuggestions)`
  Parameters:

    `component` |  |
    `preferredSuggestions` |  |

  Return:
    `Object`

### __fetchSpecificSuggestionsComplete

`Object __fetchSpecificSuggestionsComplete(Object component,
Object suggestions)`
  Parameters:

    `component` |  |
    `suggestions` |  |

  Return:
    `Object`

### GetCombinedDisplayValue

`protected Object GetCombinedDisplayValue(Object newValues)`
  Parameters:

    `newValues` |  |

  Return:
    `Object`

### GetDisplayValue

`protected Object GetDisplayValue(Object component,
Object domElement,
Object unconditional)`
  Override to support multi-selection
  Parameters:

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

  Return:
    `Object`

### __getLocalSelections

`Object __getLocalSelections()`
  Returns an object with values as key, and suggestionObjs as value. If the suggestionObj is still not available, then the value corresponding to such a key will be null, but the key will still be present in the object. Hence this object serves as a single source of truth to identify if a value is selected or not.
  Return:
    `Object`

### GetReadyState

`protected Object GetReadyState()`
  Works in tandem with registerLoadingComponent and unregisterLoadingComponent calls done in this peer.
  Return:
    `Object`

### GetRealNewValues

`protected Object GetRealNewValues(Object newValues,
Object oldValues)`
  Useful in multi-selection scenario to determine which among the current selections are new selections. Returns the elements from newValues array that aren't present in oldValues e.g. if newValues=['a', 'b', 'c', 'd'] and oldValues = ['a', 'e'], then the array returned will be ['b', 'c', 'd']
  Parameters:

    `newValues` |  |
    `oldValues` |  |

  Return:
    `Object`

### _getSelectionForValue

`private static Object _getSelectionForValue(Object value,
Object selections)`
  Parameters:

    `value` |  |
    `selections` |  |

  Return:
    `Object`

### GetSuggestionMapContainingSelections

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

    `newValues` | - | - optional parameter, set only when there is value change having the new values.

  Return:
    `Object`

### GetSuggestionsPanel

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

### _getUnresolvedValues

`private Object _getUnresolvedValues(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### _hasUnresolvedValues

`private Object _hasUnresolvedValues(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### InitDomElement

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

    `component` |  |
    `element` |  |

  Return:
    `Object`

### InitSubclass

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

### IsUnderAutocompletion

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

### PrefetchComplete

`protected Object PrefetchComplete(Object component,
Object suggestions,
Object isListComprehensive)`
  Parameters:

    `component` |  |
    `suggestions` |  |
    `isListComprehensive` |  |

  Return:
    `Object`

### RenderSelections

`protected Object RenderSelections(Object component)`
  Renders the selections list
  Parameters:

    `component` |  |

  Return:
    `Object`

### __resolveLocalSelections

`Object __resolveLocalSelections(AdfRichInputSearch component,
AdfSuggestionMap suggestions)`
  If there are any more values for which the entire suggestion obj needs to be retrieved, do it here.
  Parameters:

    `component` |  |
    `suggestions` |  |

  Return:
    `Object`

### RestoreSelectionOnEscape

`protected Object RestoreSelectionOnEscape(Object component,
Object domElement,
Object contentNode)`
  Parameters:

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

  Return:
    `Object`

### RunValidation

`protected Object RunValidation(Object component,
Object contentNode,
Object isChangeRequired)`
  Invoked from popup closed handler. This entire peer class doesn't use the lastValue expando from the AdfDhtmlInputBasePeer for validation purpose
  Parameters:

    `component` |  |
    `contentNode` |  |
    `isChangeRequired` |  |

  Return:
    `Object`

### _selectionSeedingComplete

`private Object _selectionSeedingComplete(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### _setSelectionsCount

`private static Object _setSelectionsCount(Object component,
Object element,
Object size)`
  Parameters:

    `component` |  |
    `element` |  |
    `size` |  |

  Return:
    `Object`

### ShowSelectionsPopup

`protected Object ShowSelectionsPopup(Object component,
Object contentNode)`
  Parameters:

    `component` |  |
    `contentNode` |  |

  Return:
    `Object`

### ToggleDisplayValueToFiltering

`protected Object ToggleDisplayValueToFiltering(Object contentNode,
Object keyCode)`
  Prepares the contentNode to enable filtering. Is invoked just prior to launch of suggestions popup.
  Parameters:

    `contentNode` |  |
    `keyCode` |  |

  Return:
    `Object`

### UpdateDisplayValueAndSelection

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

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

  Return:
    `Object`

### _updateLocalSelections

`private Object _updateLocalSelections(Object newValues,
Object oldLocalSelections,
Object displayedSuggestions)`
  Parameters:

    `newValues` |  |
    `oldLocalSelections` |  |
    `displayedSuggestions` |  |

  Return:
    `Object`

### _updateSelectionsCount

`private static Object _updateSelectionsCount(Object component,
Object element,
Object size)`
  Parameters:

    `component` |  |
    `element` |  |
    `size` |  |

  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.