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

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

Direct Known Subclasses:
  AdfDhtmlInputBasePeer, AdfDhtmlInputNumberSliderBasePeer, AdfDhtmlRichTextEditorBasePeer, AdfDhtmlSelectBooleanCheckboxPeer, AdfDhtmlSelectManyPeer, AdfDhtmlSelectOnePeer

    public class AdfDhtmlEditableValuePeer
    extends AdfDhtmlValuePeer

Subclasses of this should implement - GetSubmittedValue - return a value (or array of values for a selectMany) that are ready to be passed to the converter's getAsObject function - SetDisplayValue - this method is defined on AdfDhtmlValuePeer. This method takes a value that has already been converted. For example on inputText it would be passed a string, and on a selectMany an array of strings. Subclasses do not need to implement GetDisplayValue. GetDisplayValue will eventually call through to GetSubmittedValue.

## Field Summary
`protected Object` | `ComponentLabelChanged` Default optimized label setter for subclasses that support labels and for which an implementation which sets the label by setting the text of the label element is sufficient.
`protected Object` | `ComponentShowRequiredChanged`
`private static Object` | `_CONTENT_ID`
`private static Object` | `_CONTENT_ID_ATTR_NAME`
`private static Object` | `_HELPICON_ID`
`private static Object` | `_INIT_VALUE_EXPANDO`
`private static Object` | `_INITIALIZED`
`private static Object` | `_INSTRUCTIONS_TEXT`
`private static Object` | `_LAST_SUBMITTED_VALUE_EXPANDO`
`private static Object` | `_MARK_DIRTY`
`private static Object` | `_NOTE_WINDOW_FOOTER_STYLE_CLASS`
`private static Object` | `_NOTE_WINDOW_HINT_TEXT_STYLE_CLASS`
`private static Object` | `_NOTE_WINDOW_INSTRUCTIONS_STYLE_CLASS`
`private static Object` | `_NOTE_WINDOW_MAX_WIDTH`
`private static Object` | `_NOTE_WINDOW_POPUP_ID`
`private static Object` | `_NOTE_WINDOW_SEPARATOR_STYLE_CLASS`
`private static Object` | `_NOTE_WINDOW_SHORT_DESC_STYLE_CLASS`
`private static Object` | `_OLD_VALUE_EXPANDO`

### 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` | `AdfDhtmlEditableValuePeer()` Subclasses of this should implement - GetSubmittedValue - return a value (or array of values for a selectMany) that are ready to be passed to the converter's getAsObject function - SetDisplayValue - this method is defined on AdfDhtmlValuePeer.

## Method Summary
`private Object` | `_addMessageTimeout(Object componentId)`
`public Object` | `autoSubmit(Object component)` Handle autoSubmitting when the converter has returned undefined
`protected Object` | `BindToComponent(Object component, Object domElement)` Update any state necessary to bind to the current DOM component
`protected Boolean` | `ComponentChanged(AdfDomComponentFocusEvent componentEvent)` Convenience function for determining whether the active component has changed.
`static Object` | `__componentLabelChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object` | `ComponentSubmittedValueChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`public Object` | `disableBrowserAutoComplete(Object component)` Disables the browser auto-complete property of the input element bound to the component instance.
`protected Object` | `Focus()` Override of AdfRichUIPeer.Focus.
`private Object` | `_getAncestorMatchingType(Object component, Object componentTypes)` Walk up the parent hierarchy to the root element to find if the "componentTypes" is an ancestor of "component".
`protected String` | `GetComponentLabel(Object component, Object domElement)` Default optimized label getter for subclasses that support labels and for which an implementation which retrieves the label text by getting the text of the label element is sufficient.
`protected Object` | `GetComponentSubmittedValue(Object component, Object domElement)`
`protected Object` | `GetComponentValue(Object component, Object domElement)`
`public static Object` | `getContentNode(Object component, Object rootNode)` Returns the content node of the supplied component.
`protected static Object` | `GetContentNode(Object component, Object rootNode)` Deprecated: This method has been deprecated. Please use AdfDhtmlEditableValuePeer.getContentNode
`protected static Object` | `GetContentNodeId(Object component, Object rootNode)` The 'content' node is the one with an html id that has a subId of 'content', so if the id of the component is 'foo', the html id is 'foo::content'.
`public static Object` | `getContentNodeText(Object component, Object domElement)` Returns the contentNode value handling the case if the component is readonly
`protected Object` | `GetDisplayValue(Object component, Object domElement, Object unconditional)` return a value that is ready to be passed to the converter
`protected static Object` | `GetLabelElement(Object contentNode)` Returns the label element for the passed in input element
`protected static Object` | `GetLabelText(Object component)` Returns the label for the component.
`public Object` | `getLastSubmittedValue(Object component)` Returns the value that was submitted in the last request to the server..
`public Object` | `getMarkDirtyFlag()` For Internal use only.
`protected Object` | `GetNoteWindowAlignmentHint()`
`protected Object` | `GetNoteWindowAlignmentNode(Object component, Object rootNode)` Returns the node for which to align the note help window
`private Object` | `_getPublicComponentOrAncestor(Object component)` Return the first public component or its ancestor if the component is a private child, otherwise itself
`private Object` | `_getStashedValue(Object component, Object domElement, Object expandoKey)`
`protected Object` | `GetSubmittedValue(Object component, Object domElement)` Returns the submittedValue by getting the value of the input dom node.
`protected Object` | `GetValidatorHints(Object component)` Returns the hints for all used validators of the peer in a JS array.
`protected Object` | `HandleComponentClick(Object componentEvent)`
`protected Object` | `HandleComponentFocus(Object componentEvent)`
`protected Object` | `HandleComponentKeyUp(Object componentEvent)`
`private Object` | `_hideNoteTimeoutCallback(Object params)`
`protected Object` | `HideNoteWindow(Object component, Object ignoreNoteWindowTimeouts)` Hides the note window attached to the component.
`protected Object` | `InitDomElement(Object component, Object domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()`
`protected Object` | `IsInitialized(Object component, Object domElement)`
`protected Object` | `IsNoteWindowVisible(Object component)`
`Object` | `__isSpuriousDirtyValue(Object page, Object component)` Tests whether our current input value is dirty, by comparing against the last known value.
`private Object` | `_killNoteWindowFocusTimeout()`
`private Object` | `_killNoteWindowMouseTimeout()`
`private Object` | `_killNoteWindowTimeout()`
`protected Object` | `LazyInitialize(Object component, Object domElement)` We need to initialize the 'value' property before the user makes any changes so that we're not going to the peer for the 'value' property in the component.setProperty method.
`protected Object` | `MessageNotify(Object maxType, Object messages)` Overrides to hide the note window when the message changes.
`protected Object` | `MessageShow(Object maxType, Object messages)` Overrides to hide the note window when the message changes.
`protected Object` | `NeedsSpuriousDirtyValueTracking()` Determines whether we should manually track the peer's input value in order to work around problems with Selenium RC failing to properly simulate DOM events.
`private Object` | `_needsSpuriousDirtyValueTracking(Object page)`
`private Object` | `_onFocusTimeout(Object componentId)`
`private Object` | `_onMouseOverTimeout(Object componentId)`
`Object` | `__resetSpuriousDirtyValue(Object page, Object component)` Called by {@link AdfDirtyStateService} to let us know that the spurious dirty value has been processed, and that we can now clean up the initial value that we previously stashed away.
`static Object` | `__restoreDirtyDisplayValue(Object component, Object peer, Object restoredValue, Object savedActiveComponentId)` Sets the display value of an editable component to the restoreValue being passed.
`public Object` | `setLastSubmittedValue(Object component, Object submittedValue)` Sets the last submitted value on the component.
`public Object` | `setMarkDirtyFlag(Object flag)` For Internal use only.
`private static Object` | `_shouldHideNoteWindow(Object component, Object time)`
`private Object` | `_shouldScheduleNoteWindowAutoDismissal()`
`protected Object` | `ShouldShowHint(Object component, Object domElement)` Controls whether we show hints in the note window.
`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'
`protected Object` | `ShowNoteWindowMouseOver(Object componentEvent)`
`private Object` | `_stashInitValue(Object component, Object domElement)`
`protected Object` | `StashOldValue(Object component, Object domElement)` If we need to postpone validation, we stash the old value for later comparison
`private Object` | `_stashValue(Object component, Object domElement, Object expandoKey, Object onlyIfNull)` Stashes away the current submitted value for later use.
`protected Object` | `StopArrowKeyBubbling(Object componentEvent)` Stops arrow key events from bubbling when the event target is the content node.
`protected Object` | `Validate(Object component, Object submittedValue)` This method is also invoked by OATS
`protected Object` | `ValidateAndStashNewValue(Object component, Object domElement, Object curValue)` If the old value doesn't equal the cur value, then a validate needs to happen and we need to stash the new value.
`protected Object` | `ValidateIfStashedOldValue(Object component, Object domElement)` If we have stashed the old value, that means we have a pending validate that needs to happen (only if the value has changed).
`protected Object` | `VetoShowNoteWindow(Object component)`
`protected Object` | `WasSubmitted(Object component)` Override this method to return "false" if the component was not actually submitted (if, for instance, it was disabled or "read-only".

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlValuePeer
`ComponentValueChanged, GetBestMatchSubId, getConvertedObject, getConvertedValue, getFormatHint, GetFormattedDisplayValue, GetNullDefault, GetSubIdDomElement, isEmpty, setDisplayValue, 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, 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, initialize, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, 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

### ComponentLabelChanged

`protected Object ComponentLabelChanged`
  Default optimized label setter for subclasses that support labels and for which an implementation which sets the label by setting the text of the `label` element is sufficient.

  Note this setter is not registered in the AdfDhtmlEditableValuePeer. Subclasses are responsible for registering the existence of a label setter themselves if they want to use this implementation.

### ComponentShowRequiredChanged

`protected Object ComponentShowRequiredChanged`

### _CONTENT_ID

`private static Object _CONTENT_ID`

### _CONTENT_ID_ATTR_NAME

`private static Object _CONTENT_ID_ATTR_NAME`

### _HELPICON_ID

`private static Object _HELPICON_ID`

### _INIT_VALUE_EXPANDO

`private static Object _INIT_VALUE_EXPANDO`

### _INITIALIZED

`private static Object _INITIALIZED`

### _INSTRUCTIONS_TEXT

`private static Object _INSTRUCTIONS_TEXT`

### _LAST_SUBMITTED_VALUE_EXPANDO

`private static Object _LAST_SUBMITTED_VALUE_EXPANDO`

### _MARK_DIRTY

`private static Object _MARK_DIRTY`

### _NOTE_WINDOW_FOOTER_STYLE_CLASS

`private static Object _NOTE_WINDOW_FOOTER_STYLE_CLASS`

### _NOTE_WINDOW_HINT_TEXT_STYLE_CLASS

`private static Object _NOTE_WINDOW_HINT_TEXT_STYLE_CLASS`

### _NOTE_WINDOW_INSTRUCTIONS_STYLE_CLASS

`private static Object _NOTE_WINDOW_INSTRUCTIONS_STYLE_CLASS`

### _NOTE_WINDOW_MAX_WIDTH

`private static Object _NOTE_WINDOW_MAX_WIDTH`

### _NOTE_WINDOW_POPUP_ID

`private static Object _NOTE_WINDOW_POPUP_ID`

### _NOTE_WINDOW_SEPARATOR_STYLE_CLASS

`private static Object _NOTE_WINDOW_SEPARATOR_STYLE_CLASS`

### _NOTE_WINDOW_SHORT_DESC_STYLE_CLASS

`private static Object _NOTE_WINDOW_SHORT_DESC_STYLE_CLASS`

### _OLD_VALUE_EXPANDO

`private static Object _OLD_VALUE_EXPANDO`

## Constructor Detail

### AdfDhtmlEditableValuePeer

`public AdfDhtmlEditableValuePeer()`
  Subclasses of this should implement - GetSubmittedValue - return a value (or array of values for a selectMany) that are ready to be passed to the converter's getAsObject function - SetDisplayValue - this method is defined on AdfDhtmlValuePeer. This method takes a value that has already been converted. For example on inputText it would be passed a string, and on a selectMany an array of strings. Subclasses do not need to implement GetDisplayValue. GetDisplayValue will eventually call through to GetSubmittedValue.

## Method Detail

### _addMessageTimeout

`private Object _addMessageTimeout(Object componentId)`
  Parameters:

    `componentId` |  |

  Return:
    `Object`

### autoSubmit

`public Object autoSubmit(Object component)`
  Handle autoSubmitting when the converter has returned undefined
  Parameters:

    `component` |  |

  Return:
    `Object`

### BindToComponent

`protected Object BindToComponent(Object component,
Object domElement)`
  Update any state necessary to bind to the current DOM component
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.BindToComponent(Object, Object)`

### ComponentChanged

`protected Boolean ComponentChanged(AdfDomComponentFocusEvent componentEvent)`
  Convenience function for determining whether the active component has changed. This function should be passed a focus or blur event, so for example, you could call this function from within `HandleComponentFocus`.
  Parameters:

    `componentEvent` | - | A component focus event

  Return:
    `Boolean` - Returns undefined if `componentEvent` is not an instance of `AdfDomComponentFocusEvent`. Otherwise, returns true if the active component changed; else, false.

### __componentLabelChanged

`static Object __componentLabelChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `newValue` |  |
    `oldValue` |  |

  Return:
    `Object`

### ComponentSubmittedValueChanged

`protected Object ComponentSubmittedValueChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `newValue` |  |
    `oldValue` |  |

  Return:
    `Object`

### disableBrowserAutoComplete

`public Object disableBrowserAutoComplete(Object component)`
  Disables the browser auto-complete property of the input element bound to the component instance.
  Parameters:

    `component` |  |

  Return:
    `Object`

### Focus

`protected Object Focus()`
  Override of AdfRichUIPeer.Focus. The first tab stop could be the help icon or context facet so we want to move to the content.
  Return:
    `Object`
  Overrides:
    `AdfUIPeer.focus(Object)`

### _getAncestorMatchingType

`private Object _getAncestorMatchingType(Object component,
Object componentTypes)`
  Walk up the parent hierarchy to the root element to find if the "componentTypes" is an ancestor of "component". If matching element is found, component is returned otherwise null is returned.
  Parameters:

    `component` |  |
    `componentTypes` |  |

  Return:
    `Object`

### GetComponentLabel

`protected String GetComponentLabel(Object component,
Object domElement)`
  Default optimized label getter for subclasses that support labels and for which an implementation which retrieves the label text by getting the text of the `label` element is sufficient.

  Note this getter is not registered in the AdfDhtmlEditableValuePeer. Subclasses are responsible for registering the existence of a label getter themselves if they want to use this implementation, e.g., AdfRichUIPeer.addComponentPropertyGetters(this, AdfRichInputText.LABEL);

  Parameters:

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

  Return:
    `String` - label

### GetComponentSubmittedValue

`protected Object GetComponentSubmittedValue(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### GetComponentValue

`protected Object GetComponentValue(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

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

### getContentNode

`public static Object getContentNode(Object component,
Object rootNode)`
  Returns the content node of the supplied component. This will be used to determine where the note window should be aligned to and provides some convenience methods for subclasses of this component. Passing the rootNode is optional, the method will call AdfRichUIPeer.getDomElementForComponent(component) to figure out the root node if you don't pass in anything.
  Parameters:

    `component` |  |
    `rootNode` |  |

  Return:
    `Object`

### GetContentNode

`protected static Object GetContentNode(Object component,
Object rootNode)`
  Deprecated: This method has been deprecated. Please use AdfDhtmlEditableValuePeer.getContentNode
  Parameters:

    `component` |  |
    `rootNode` |  |

  Return:
    `Object`

### GetContentNodeId

`protected static Object GetContentNodeId(Object component,
Object rootNode)`
  The 'content' node is the one with an html id that has a subId of 'content', so if the id of the component is 'foo', the html id is 'foo::content'. Passing the rootNode is optional, the method will call AdfRichUIPeer.getDomElementForComponent(component) to figure out the root node if you don't pass in anything.
  Parameters:

    `component` |  |
    `rootNode` |  |

  Return:
    `Object`

### getContentNodeText

`public static Object getContentNodeText(Object component,
Object domElement)`
  Returns the contentNode value handling the case if the component is readonly
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### GetDisplayValue

`protected Object GetDisplayValue(Object component,
Object domElement,
Object unconditional)`
  return a value that is ready to be passed to the converter
  Parameters:

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

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

### GetLabelElement

`protected static Object GetLabelElement(Object contentNode)`
  Returns the label element for the passed in input element
  Parameters:

    `contentNode` |  |

  Return:
    `Object`

### GetLabelText

`protected static Object GetLabelText(Object component)`
  Returns the label for the component. If the component has a label attribute, that will be returned, otherwise the text of any HTML label element for the component's content element will be returned
  Parameters:

    `component` |  |

  Return:
    `Object`

### getLastSubmittedValue

`public Object getLastSubmittedValue(Object component)`
  Returns the value that was submitted in the last request to the server..
  Parameters:

    `component` |  |

  Return:
    `Object`

### getMarkDirtyFlag

`public Object getMarkDirtyFlag()`
  For Internal use only. Returns the MarkDirtyFlag value of the component.
  Return:
    `Object`

### GetNoteWindowAlignmentHint

`protected Object GetNoteWindowAlignmentHint()`
  Return:
    `Object`

### GetNoteWindowAlignmentNode

`protected Object GetNoteWindowAlignmentNode(Object component,
Object rootNode)`
  Returns the node for which to align the note help window
  Parameters:

    `component` |  |
    `rootNode` |  |

  Return:
    `Object`

### _getPublicComponentOrAncestor

`private Object _getPublicComponentOrAncestor(Object component)`
  Return the first public component or its ancestor if the component is a private child, otherwise itself
  Parameters:

    `component` |  |

  Return:
    `Object`

### _getStashedValue

`private Object _getStashedValue(Object component,
Object domElement,
Object expandoKey)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `expandoKey` |  |

  Return:
    `Object`

### GetSubmittedValue

`protected Object GetSubmittedValue(Object component,
Object domElement)`
  Returns the submittedValue by getting the value of the input dom node.
  Parameters:

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

  Return:
    `Object` - submittedValue

### GetValidatorHints

`protected Object GetValidatorHints(Object component)`
  Returns the hints for all used validators of the peer in a JS array.
  Parameters:

    `component` |  |

  Return:
    `Object`

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentFocus

`protected Object HandleComponentFocus(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentKeyUp

`protected Object HandleComponentKeyUp(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### _hideNoteTimeoutCallback

`private Object _hideNoteTimeoutCallback(Object params)`
  Parameters:

    `params` |  |

  Return:
    `Object`

### HideNoteWindow

`protected Object HideNoteWindow(Object component,
Object ignoreNoteWindowTimeouts)`
  Hides the note window attached to the component. The API by default cancels any pending note window timeouts if any.
  Parameters:

    `component` |  |
    `ignoreNoteWindowTimeouts` | - | true to leave all note window related timeouts untouched

  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(Object 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()`
  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.InitSubclass()`

### IsInitialized

`protected Object IsInitialized(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### IsNoteWindowVisible

`protected Object IsNoteWindowVisible(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### __isSpuriousDirtyValue

`Object __isSpuriousDirtyValue(Object page,
Object component)`
  Tests whether our current input value is dirty, by comparing against the last known value. This is called by the `AdfDirtyStateService` to determine whether an editable component should be treated as dirty even though no `AdfValueChangeEvent` has been received. See documentation for `NeedsSpuriousDirtyValueTracking()` above for details. Note that we don't expect that we'll be bound at the point that this is called.
  Parameters:

    `page` |  |
    `component` |  |

  Return:
    `Object`

### _killNoteWindowFocusTimeout

`private Object _killNoteWindowFocusTimeout()`
  Return:
    `Object`

### _killNoteWindowMouseTimeout

`private Object _killNoteWindowMouseTimeout()`
  Return:
    `Object`

### _killNoteWindowTimeout

`private Object _killNoteWindowTimeout()`
  Return:
    `Object`

### LazyInitialize

`protected Object LazyInitialize(Object component,
Object domElement)`
  We need to initialize the 'value' property before the user makes any changes so that we're not going to the peer for the 'value' property in the component.setProperty method. See explanation below. Background: 1. In component.setProperty if the old and new value of a property are equal the setProperty method returns without setting anything. This is to avoid unnecessary propertyChangeEvents. 2. We do not send down the 'value' property from the server, so the 'value' property starts out undefined. If a property is undefined then calls to get the current value will go to the peer. So initally calls to getValue() go to the peer's GetComponentValue() Issue: - Mostly component.setProperty will only be called after the user makes a change, and if the property is currently undefined the peer's property getter will be called for the 'old' value. The peer will then return the current value, which is the new changed value. - That means the 'old' value is the same as the new value, and so the property is not set (see point 1 above). - Therefore we need to initialize the 'value' property before the user makes any changes so that we're not going to the peer for the 'value' property in the component.setProperty method.
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### MessageNotify

`protected Object MessageNotify(Object maxType,
Object messages)`
  Overrides to hide the note window when the message changes.
  Parameters:

    `maxType` |  |
    `messages` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.messageNotify(Object, Number, Array)`

### MessageShow

`protected Object MessageShow(Object maxType,
Object messages)`
  Overrides to hide the note window when the message changes.
  Parameters:

    `maxType` |  |
    `messages` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.messageShow(Object, Number, Array)`

### NeedsSpuriousDirtyValueTracking

`protected Object NeedsSpuriousDirtyValueTracking()`
  Determines whether we should manually track the peer's input value in order to work around problems with Selenium RC failing to properly simulate DOM events. If this method is overridden to return true, AdfDhtmlEditableValuePeer will store the component's submitted value during InitDomElement() and will use this to determine whether the value we've got a "spurious" dirty value when "#__isSpuriousValue()" is called. This method should be overridden to return by any subclass that may be tripped up by Selenium RC's failure to properly simulate DOM events. See `AdfDirtyStateService` for more details.
  Return:
    `Object`

### _needsSpuriousDirtyValueTracking

`private Object _needsSpuriousDirtyValueTracking(Object page)`
  Parameters:

    `page` |  |

  Return:
    `Object`

### _onFocusTimeout

`private Object _onFocusTimeout(Object componentId)`
  Parameters:

    `componentId` |  |

  Return:
    `Object`

### _onMouseOverTimeout

`private Object _onMouseOverTimeout(Object componentId)`
  Parameters:

    `componentId` |  |

  Return:
    `Object`

### __resetSpuriousDirtyValue

`Object __resetSpuriousDirtyValue(Object page,
Object component)`
  Called by `AdfDirtyStateService` to let us know that the spurious dirty value has been processed, and that we can now clean up the initial value that we previously stashed away.
  Parameters:

    `page` |  |
    `component` |  |

  Return:
    `Object`

### __restoreDirtyDisplayValue

`static Object __restoreDirtyDisplayValue(Object component,
Object peer,
Object restoredValue,
Object savedActiveComponentId)`
  Sets the display value of an editable component to the restoreValue being passed.
  Parameters:

    `component` | - | Component whose display value is to be restored
    `peer` | - | Peer of the component
    `restoredValue` | - | Value which needs to be set to the component
    `savedActiveComponentId` | - | id of active component saved before applying rich response

  Return:
    `Object`

### setLastSubmittedValue

`public Object setLastSubmittedValue(Object component,
Object submittedValue)`
  Sets the last submitted value on the component.
  Parameters:

    `component` |  |
    `submittedValue` |  |

  Return:
    `Object`

### setMarkDirtyFlag

`public Object setMarkDirtyFlag(Object flag)`
  For Internal use only. Sets the MarkDirtyFlag value on the component.
  Parameters:

    `flag` |  |

  Return:
    `Object`

### _shouldHideNoteWindow

`private static Object _shouldHideNoteWindow(Object component,
Object time)`
  Parameters:

    `component` |  |
    `time` |  |

  Return:
    `Object`

### _shouldScheduleNoteWindowAutoDismissal

`private Object _shouldScheduleNoteWindowAutoDismissal()`
  Return:
    `Object`

### ShouldShowHint

`protected Object ShouldShowHint(Object component,
Object domElement)`
  Controls whether we show hints in the note window. Default is to not show hints in note window, override to show.
  Parameters:

    `component` |  |
    `domElement` |  |

  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`

### ShowNoteWindowMouseOver

`protected Object ShowNoteWindowMouseOver(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### _stashInitValue

`private Object _stashInitValue(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### StashOldValue

`protected Object StashOldValue(Object component,
Object domElement)`
  If we need to postpone validation, we stash the old value for later comparison
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _stashValue

`private Object _stashValue(Object component,
Object domElement,
Object expandoKey,
Object onlyIfNull)`
  Stashes away the current submitted value for later use. The value is only stashed for non-readyOnly components.
  Parameters:

    `component` | - | the component for this peer
    `domElement` |  |
    `expandoKey` |  |
    `onlyIfNull` | - | if true, we only stash the value if it is not already stashed under the specified key.

  Return:
    `Object`

### StopArrowKeyBubbling

`protected Object StopArrowKeyBubbling(Object componentEvent)`
  Stops arrow key events from bubbling when the event target is the content node.
  Parameters:

    `componentEvent` | - | the component event

  Return:
    `Object`

### Validate

`protected Object Validate(Object component,
Object submittedValue)`
  This method is also invoked by OATS
  Parameters:

    `component` |  |
    `submittedValue` |  |

  Return:
    `Object`

### ValidateAndStashNewValue

`protected Object ValidateAndStashNewValue(Object component,
Object domElement,
Object curValue)`
  If the old value doesn't equal the cur value, then a validate needs to happen and we need to stash the new value. This is normally called from the blur handler and is primarily used by screen reader peers.
  Parameters:

    `component` |  |
    `domElement` |  |
    `curValue` |  |

  Return:
    `Object`

### ValidateIfStashedOldValue

`protected Object ValidateIfStashedOldValue(Object component,
Object domElement)`
  If we have stashed the old value, that means we have a pending validate that needs to happen (only if the value has changed).
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### VetoShowNoteWindow

`protected Object VetoShowNoteWindow(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### WasSubmitted

`protected Object WasSubmitted(Object component)`
  Override this method to return "false" if the component was not actually submitted (if, for instance, it was disabled or "read-only".
  Parameters:

    `component` |  |

  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.