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

## 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.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.AdfDhtmlValuePeer
                               |
                               +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
                                     |
                                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputBasePeer
                                           |
                                           +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputListOfValuesSuperBasePeer

Direct Known Subclasses:
  AdfDhtmlInputListOfValuesBasePeer, AdfDhtmlInputListOfValuesBasePeer

    public class AdfDhtmlInputListOfValuesSuperBasePeer
    extends AdfDhtmlInputBasePeer

Base Peer for the inputListOfValues components.

## Field Summary
`private static Object` | `_clientId`
`private static Object` | `_DIALOG_CONTENT_HEIGHT`
`private static Object` | `_DIALOG_CONTENT_WIDTH`
`private static Object` | `_EDIT_MODE_SELECT`
`private static Object` | `_INTERNAL_QUERY_ID`
`private static Object` | `_INTERNAL_TABLE_SUFFIX_ID`
`private static Object` | `_LOVINTERNAL_DIALOG_SUFFIX_ID`
`private static Object` | `_LOVINTERNAL_EVENT_QUEUED`
`private static Object` | `_OK_PRESSED`
`private static Object` | `_POPUP_SUFFIX_ID`
`private static Object` | `_SHOWN`

### Fields inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`ComponentLabelChanged, ComponentShowRequiredChanged`

### Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, CreateSubId, DISABLED_STYLECLASS, DRAG_READY_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS, SELECTED_STYLECLASS`

### Fields inherited from oracle.adf.view.js.base.AdfObject
`constructor, superclass`

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

## Constructor Summary
`public` | `AdfDhtmlInputListOfValuesSuperBasePeer()` Base Peer for the inputListOfValues components.

## Method Summary
`protected Object` | `AnnounceAutoComplete()` Announce to assistive technologies that the lov field is autocompleted.
`protected Object` | `AutoTab(Object component, Object node)` When autoTab is set to true and the maxlength for the input has been reached, we do a tab to the next possible tabstop, using AdfFoucsUtils.
`private void` | `_busyStateListener(Object event)` Captures the busy state event and applies it to the dialog buttons.
`protected Object` | `ComponentRemoved(AdfUIComponent component)` Handles the removal of a component.
`protected static Object` | `FocusInputElement(Object component)` The function to set the focus on the input element of the component
`protected Object` | `FocusNextElement(Object node)` Sets the focus on the next component element which is a tabstop called from AutoTab function
`public Object` | `getConvertedObject(Object component, Object value)` This usually gets the converter and calls getAsString.
`protected static Object` | `GetLabelText(Object component)` In addition to label & labelAndAccessKey attribute, this looks for other label elements for the lov's input field.
`private static Object` | `_getLovPopup(Object lovClientId)` Convenience function to get the lovpopup component using the lov component clientID
`protected Object` | `HandleComponentClickOrTouch(Object componentEvent)` Invoked from desktop.AdfDhtmlInputListOfValuesBasePeer.HandleComponentClick or touch.AdfDhtmlInputListOfValuesBasePeer.HandleComponentTouchEnd
`protected Object` | `HandleComponentDblClick(Object componentEvent)` Event handler for the double click on the table component inside dialog
`protected Object` | `HandleComponentDialog(Object componentEvent)` Event handler for the dialog event.
`protected Object` | `HandleComponentKeyDown(Object componentEvent)`
`protected Object` | `HandleComponentKeyPress(Object componentEvent)` Implements keyPress event handling for lov components.
`protected Object` | `HandleComponentKeyUp(Object componentEvent)` Implements keyUp event handling for lov components.
`protected Object` | `HandleComponentPopupClosed(Object componentEvent)` Handler for the popup closed event, sets the _shown attribute to false om lov component when the popup dialog is closed
`protected Object` | `HandleComponentPopupOpening(Object componentEvent)` Handler for the popup dialog popup opening event.
`private Object` | `_handleInput(Object componentEvent)`
`protected Object` | `InitDomElement(AdfUIComponent component, Object domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()` Initialize the dialog events for the lov popup dialog and double click events to select the row and return the value when double click happens inside a table
`protected Object` | `IsCancelBackSpaceKeyEvent(Object component, Object componentEvent)` Decides if backspace keydown event needs to be cancelled.
`protected Object` | `IsKeyEventInInput(Object component, Object componentEvent)` Returns true if the key is pressed inside the input field
`protected Object` | `IsLovPopupVisible(Object clientId)` Convenience function to know whether the lov popup is visible or not
`protected Object` | `IsNoteWindowVisible(Object component)`
`private Object` | `_queueLovInternalEvent(Object component, Object targetNode)` verifies whether the value is changed after the input element got focus and queues the lovInternalEvent if the value is changed.
`public Object` | `setAriaExpanded(Object component, Object isExpanded)` Sets aria-expanded on the content element
`protected Object` | `SetDisplayValue(Object component, Object domElement, Object newValue)` Set the display string, Overridden as rows attribute is not defined on LOV components
`private static Object` | `_setShown(Object component, Object shown)` convenience function to set the _shown property on the component to decide whether the pop dialog is shown or not
`protected Object` | `ShowNoteWindow(Object component, Object isMouseOver)` - kill any timeout to show the note window - if there is no note window visible create it if needed - if there is a note window shown and isMouseOver is false change the autodismiss hint to 'menu'
`public Object` | `showToolbarPopup(Object clientId, Object popupId)` This function will be called when the commandToolbarButton inside the lov dialog is clicked.
`private Object` | `_toolbarPopupClosed(Object componentEvent)` This function will be called when the toolbar popup is closed.

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputBasePeer
`CheckLength, getLastValue, GetSubmittedValue, HandleComponentBlur, HandleComponentFocus, initialize, needsFocusTargetStyleClass, NeedsSpuriousDirtyValueTracking, preventNextValueSubmission, RunValidation, setLastValue, ShouldShowHint, __simulateBlur, UpdateLastValue, VetoBlurValidation, WasSubmitted`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`autoSubmit, BindToComponent, ComponentChanged, __componentLabelChanged, ComponentSubmittedValueChanged, disableBrowserAutoComplete, Focus, GetComponentLabel, GetComponentSubmittedValue, GetComponentValue, getContentNode, GetContentNode, GetContentNodeId, getContentNodeText, GetDisplayValue, GetLabelElement, getLastSubmittedValue, getMarkDirtyFlag, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HandleComponentClick, HideNoteWindow, IsInitialized, __isSpuriousDirtyValue, LazyInitialize, MessageNotify, MessageShow, __resetSpuriousDirtyValue, __restoreDirtyDisplayValue, setLastSubmittedValue, setMarkDirtyFlag, ShowNoteWindowMouseOver, StashOldValue, StopArrowKeyBubbling, Validate, ValidateAndStashNewValue, ValidateIfStashedOldValue, VetoShowNoteWindow`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlValuePeer
`ComponentValueChanged, GetBestMatchSubId, getConvertedValue, getFormatHint, GetFormattedDisplayValue, GetNullDefault, GetSubIdDomElement, isEmpty, setDisplayValue`

### Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, DomReplaceNotify, focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDomRootNodes, GetDomRootNodes, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, GetElementToReplaceWithSVG, getFallbackDomElement, GetFallbackDomElement, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, InitClass, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, PopupClosed, processPushData, ProcessPushData, registerADSAccessibility, RegisterADSAccessibility, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, simulateMouse, SimulateMouseOnDescendant, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, UpdateMessageType, visitChildren`

### Methods inherited from oracle.adf.view.js.base.AdfUIPeer
`getDefaultDragRecognizer, getParentPeer, Init, initiateDrag, isVisible, needsResizeNotify`

### Methods inherited from oracle.adf.view.js.base.AdfObject
`adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, exportPrototypeSymbol, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString`

## Field Detail

### _clientId

`private static Object _clientId`

### _DIALOG_CONTENT_HEIGHT

`private static Object _DIALOG_CONTENT_HEIGHT`

### _DIALOG_CONTENT_WIDTH

`private static Object _DIALOG_CONTENT_WIDTH`

### _EDIT_MODE_SELECT

`private static Object _EDIT_MODE_SELECT`

### _INTERNAL_QUERY_ID

`private static Object _INTERNAL_QUERY_ID`

### _INTERNAL_TABLE_SUFFIX_ID

`private static Object _INTERNAL_TABLE_SUFFIX_ID`

### _LOVINTERNAL_DIALOG_SUFFIX_ID

`private static Object _LOVINTERNAL_DIALOG_SUFFIX_ID`

### _LOVINTERNAL_EVENT_QUEUED

`private static Object _LOVINTERNAL_EVENT_QUEUED`

### _OK_PRESSED

`private static Object _OK_PRESSED`

### _POPUP_SUFFIX_ID

`private static Object _POPUP_SUFFIX_ID`

### _SHOWN

`private static Object _SHOWN`

## Constructor Detail

### AdfDhtmlInputListOfValuesSuperBasePeer

`public AdfDhtmlInputListOfValuesSuperBasePeer()`
  Base Peer for the inputListOfValues components.

## Method Detail

### AnnounceAutoComplete

`protected Object AnnounceAutoComplete()`
  Announce to assistive technologies that the lov field is autocompleted. Invoked from server - SimpleInputListOfValuesRendererBase.decodeInternal
  Return:
    `Object`

### AutoTab

`protected Object AutoTab(Object component,
Object node)`
  When autoTab is set to true and the maxlength for the `input` has been reached, we do a tab to the next possible tabstop, using AdfFoucsUtils. This function should only be called from within HandleComponentKeyUp!
  Parameters:

    `component` |  |
    `node` |  |

  Return:
    `Object`
  See also:
    "AdfDhtmlInputTextPeer#AutoTab"

### _busyStateListener

`private void _busyStateListener(Object event)`
  Captures the busy state event and applies it to the dialog buttons. This will prevent the dialog from being prematurely dismissed during a table data fetch (search or scroll).
  Parameters:

    `event` |  |

  Return:
    `void` - null
  See also:
    `HandleComponentPopupOpening(Object)`
    `HandleComponentDialog(Object)`

### ComponentRemoved

`protected Object ComponentRemoved(AdfUIComponent component)`
  Handles the removal of a component.
  Parameters:

    `component` | - | The component that was removed.

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.componentRemoved(AdfUIComponent)`

### FocusInputElement

`protected static Object FocusInputElement(Object component)`
  The function to set the focus on the input element of the component
  Parameters:

    `component` |  |

  Return:
    `Object`

### FocusNextElement

`protected Object FocusNextElement(Object node)`
  Sets the focus on the next component element which is a tabstop called from AutoTab function
  Parameters:

    `node` |  |

  Return:
    `Object`

### getConvertedObject

`public Object getConvertedObject(Object component,
Object value)`
  This usually gets the converter and calls getAsString. Not calling this getConvertedString since this may return a list of strings or any object that the peer understands, thus calling it getConvertedObject instead. Can return undefined if converter not successful
  Parameters:

    `component` |  |
    `value` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.getConvertedObject(Object, Object)`

### GetLabelText

`protected static Object GetLabelText(Object component)`
  In addition to label & labelAndAccessKey attribute, this looks for other label elements for the lov's input field.
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.GetLabelText(Object)`

### _getLovPopup

`private static Object _getLovPopup(Object lovClientId)`
  Convenience function to get the lovpopup component using the lov component clientID
  Parameters:

    `lovClientId` |  |

  Return:
    `Object`

### HandleComponentClickOrTouch

`protected Object HandleComponentClickOrTouch(Object componentEvent)`
  Invoked from desktop.AdfDhtmlInputListOfValuesBasePeer.HandleComponentClick or touch.AdfDhtmlInputListOfValuesBasePeer.HandleComponentTouchEnd
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentDblClick

`protected Object HandleComponentDblClick(Object componentEvent)`
  Event handler for the double click on the table component inside dialog
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentDialog

`protected Object HandleComponentDialog(Object componentEvent)`
  Event handler for the dialog event. sets the instance variable to true when ok button is pressed to queue the returnPopupData event in popupClosed event handler only when ok button is pressed and ignore it when cancel is pressed
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentKeyDown

`protected Object HandleComponentKeyDown(Object componentEvent)`
  Parameters:

    `componentEvent` | - | Key Down event Implements keyboard handling for the lov components for eg: value change and tab-out or enter will open the search and select dialog

  Return:
    `Object`

### HandleComponentKeyPress

`protected Object HandleComponentKeyPress(Object componentEvent)`
  Implements keyPress event handling for lov components. Cancels the event and stops from bubbling when the lovInternal event is queued on Enter key or Tab key press
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentKeyUp

`protected Object HandleComponentKeyUp(Object componentEvent)`
  Implements keyUp event handling for lov components. Cancels the event and stops from bubbling when the lovInternal event is queued on Enter key or Tab key press
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.HandleComponentKeyUp(Object)`

### HandleComponentPopupClosed

`protected Object HandleComponentPopupClosed(Object componentEvent)`
  Handler for the popup closed event, sets the _shown attribute to false om lov component when the popup dialog is closed
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentPopupOpening

`protected Object HandleComponentPopupOpening(Object componentEvent)`
  Handler for the popup dialog popup opening event.
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### _handleInput

`private Object _handleInput(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(AdfUIComponent component,
Object domElement)`
  Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called.
  Parameters:

    `component` | - | Component that this peer will be associated with
    `domElement` | - | Root DOM element of this peer

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)`

### InitSubclass

`protected static Object InitSubclass()`
  Initialize the dialog events for the lov popup dialog and double click events to select the row and return the value when double click happens inside a table
  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.InitSubclass()`

### IsCancelBackSpaceKeyEvent

`protected Object IsCancelBackSpaceKeyEvent(Object component,
Object componentEvent)`
  Decides if backspace keydown event needs to be cancelled.
  Parameters:

    `component` |  |
    `componentEvent` |  |

  Return:
    `Object`

### IsKeyEventInInput

`protected Object IsKeyEventInInput(Object component,
Object componentEvent)`
  Returns true if the key is pressed inside the input field
  Parameters:

    `component` |  |
    `componentEvent` |  |

  Return:
    `Object`

### IsLovPopupVisible

`protected Object IsLovPopupVisible(Object clientId)`
  Convenience function to know whether the lov popup is visible or not
  Parameters:

    `clientId` | - | of the lov component

  Return:
    `Object` - true if the popup is visible else false

### IsNoteWindowVisible

`protected Object IsNoteWindowVisible(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.IsNoteWindowVisible(Object)`

### _queueLovInternalEvent

`private Object _queueLovInternalEvent(Object component,
Object targetNode)`
  verifies whether the value is changed after the input element got focus and queues the lovInternalEvent if the value is changed. this gets called when tab key or enter key is pressed. this function depends on the inputbasepeer stashing the last value as expando property.
  Parameters:

    `component` |  |
    `targetNode` | - | , input dom element

  Return:
    `Object` - true if LovInternalEvent is queued

### setAriaExpanded

`public Object setAriaExpanded(Object component,
Object isExpanded)`
  Sets aria-expanded on the content element
  Parameters:

    `component` |  |
    `isExpanded` |  |

  Return:
    `Object`

### SetDisplayValue

`protected Object SetDisplayValue(Object component,
Object domElement,
Object newValue)`
  Set the display string, Overridden as rows attribute is not defined on LOV components
  Parameters:

    `component` |  |
    `domElement` |  |
    `newValue` | - | new string to be displayed

  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.setDisplayValue(Object, Object)`

### _setShown

`private static Object _setShown(Object component,
Object shown)`
  convenience function to set the _shown property on the component to decide whether the pop dialog is shown or not
  Parameters:

    `component` |  |
    `shown` |  |

  Return:
    `Object`

### ShowNoteWindow

`protected Object ShowNoteWindow(Object component,
Object isMouseOver)`
  - kill any timeout to show the note window - if there is no note window visible create it if needed - if there is a note window shown and isMouseOver is false change the autodismiss hint to 'menu'
  Parameters:

    `component` |  |
    `isMouseOver` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.ShowNoteWindow(Object, Object)`

### showToolbarPopup

`public Object showToolbarPopup(Object clientId,
Object popupId)`
  This function will be called when the commandToolbarButton inside the lov dialog is clicked. This is attached to the commandToolbarButton through the clientListener on server and will be called from the _createSearchContentFacet() method of SimpleInputListOfValuesRendererBase.
  Parameters:

    `clientId` | - | of the lov component
    `popupId` | - | clientId of the popup component

  Return:
    `Object`

### _toolbarPopupClosed

`private Object _toolbarPopupClosed(Object componentEvent)`
  This function will be called when the toolbar popup is closed. This is registered as the Listener for the popupClosed event for the popup with the id createPopupId.
  Parameters:

    `componentEvent` |  |

  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.