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

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

Direct Known Subclasses:
  AdfDhtmlCodeEditorPeer, AdfDhtmlInputColorPeer, AdfDhtmlInputDatePeer, AdfDhtmlInputListOfValuesSuperBasePeer, AdfDhtmlInputNumberSpinboxBasePeer, AdfDhtmlInputSearchPeer, AdfDhtmlInputTextPeer

    public class AdfDhtmlInputBasePeer
    extends AdfDhtmlEditableValuePeer

Base Peer for the input components.

## Field Summary
`private static Object` | `_LAST_VALUE`

### 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` | `AdfDhtmlInputBasePeer()` Base Peer for the input components.

## Method Summary
`protected Object` | `CheckLength(Object component, Object node)` Enforce the component's maximumLength property -- don't let the user type in more characters than maximumLength specifies.
`private Object` | `_getDefaultIsChangeRequired(Object component, Object value)`
`public static Object` | `getLastValue(Object contentNode)` Returns the last value stored in the node under the expando 'data-afr-lastvalue'.
`private Object` | `_getLength(Object component, Object value)`
`protected Object` | `GetSubmittedValue(Object component, Object domElement)` Returns the submittedValue by getting the value of the input dom node.
`private Object` | `_getSubstr(Object component, Object value, Object start, Object length)`
`protected Object` | `HandleComponentBlur(Object componentEvent)`
`protected Object` | `HandleComponentFocus(Object componentEvent)`
`public Object` | `initialize(Object component)` Initializes a peer instance about to be returned by AdfLookAndFeel.getPeer().
`protected static Object` | `InitSubclass()`
`public Object` | `needsFocusTargetStyleClass()` Test if the peer needs the :focus-target stype class injected for click-to-edit.
`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.
`public Object` | `preventNextValueSubmission()` Sets the flag to cancel next value change event.
`protected Object` | `RunValidation(Object component, Object targetNode, Object isChangeRequired)` Don't call this code unless the input element is the content node
`public static Object` | `setLastValue(Object contentNode, Object value)` Sets the expando 'data-afr-lastvalue' to the element to store the last value.
`protected Object` | `ShouldShowHint(Object component, Object domElement)` Show hints in note window for this component.
`Object` | `__simulateBlur(Object comp)` Simulates blur handling in cases when we know that the focus is lost, but onBlur is not yet called (such as when onbeforeunload is delivered)
`protected Object` | `UpdateLastValue(Object component)`
`protected Object` | `VetoBlurValidation()`
`protected Object` | `WasSubmitted(Object component)` Returns false if blur event (which results in validation) is queued but focus is lost to a DOM element within the component itself.

### 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, GetLabelText, getLastSubmittedValue, getMarkDirtyFlag, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HandleComponentClick, HandleComponentKeyUp, HideNoteWindow, InitDomElement, IsInitialized, IsNoteWindowVisible, __isSpuriousDirtyValue, LazyInitialize, MessageNotify, MessageShow, __resetSpuriousDirtyValue, __restoreDirtyDisplayValue, setLastSubmittedValue, setMarkDirtyFlag, ShowNoteWindow, ShowNoteWindowMouseOver, StashOldValue, StopArrowKeyBubbling, Validate, ValidateAndStashNewValue, ValidateIfStashedOldValue, VetoShowNoteWindow`

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

### _LAST_VALUE

`private static Object _LAST_VALUE`

## Constructor Detail

### AdfDhtmlInputBasePeer

`public AdfDhtmlInputBasePeer()`
  Base Peer for the input components.

## Method Detail

### CheckLength

`protected Object CheckLength(Object component,
Object node)`
  Enforce the component's maximumLength property -- don't let the user type in more characters than maximumLength specifies. If the mode.value exceeds the maximumLength, this method will modify the node.value by truncating it to the correct length.
  Parameters:

    `component` |  |
    `node` |  |

  Return:
    `Object` - boolean returns true if the maximum length has already been reached.

### _getDefaultIsChangeRequired

`private Object _getDefaultIsChangeRequired(Object component,
Object value)`
  Parameters:

    `component` |  |
    `value` |  |

  Return:
    `Object`

### getLastValue

`public static Object getLastValue(Object contentNode)`
  Returns the last value stored in the node under the expando 'data-afr-lastvalue'.
  Parameters:

    `contentNode` | - | Element holding the last value

  Return:
    `Object` - lastValue

### _getLength

`private Object _getLength(Object component,
Object value)`
  Parameters:

    `component` |  |
    `value` |  |

  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
  Overrides:
    `AdfDhtmlEditableValuePeer.GetSubmittedValue(Object, Object)`

### _getSubstr

`private Object _getSubstr(Object component,
Object value,
Object start,
Object length)`
  Parameters:

    `component` |  |
    `value` |  |
    `start` |  |
    `length` |  |

  Return:
    `Object`

### HandleComponentBlur

`protected Object HandleComponentBlur(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentFocus

`protected Object HandleComponentFocus(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

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

### initialize

`public Object initialize(Object component)`
  Initializes a peer instance about to be returned by AdfLookAndFeel.getPeer(). Non-framework code should never need to call this method
  Parameters:

    `component` |  |

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

### InitSubclass

`protected static Object InitSubclass()`
  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.InitSubclass()`

### needsFocusTargetStyleClass

`public Object needsFocusTargetStyleClass()`
  Test if the peer needs the :focus-target stype class injected for click-to-edit. Rather then inject this for all UI components, we're only going to inject it for peers that need it due to an IE7/rtl bug when injecting style classes onto dom elements. Default is false (don't inject the style).
  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.needsFocusTargetStyleClass()`

### 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`
  Overrides:
    `AdfDhtmlEditableValuePeer.NeedsSpuriousDirtyValueTracking()`

### preventNextValueSubmission

`public Object preventNextValueSubmission()`
  Sets the flag to cancel next value change event. This should be invoked when focus is being lost within the component from the content field. e.g. When focus is moved from InputLOV's content field to InputLOV's search icon.
  Return:
    `Object`

### RunValidation

`protected Object RunValidation(Object component,
Object targetNode,
Object isChangeRequired)`
  Don't call this code unless the input element is the content node
  Parameters:

    `component` | - | Component
    `targetNode` | - | targetNode of event
    `isChangeRequired` |  |

  Return:
    `Object`

### setLastValue

`public static Object setLastValue(Object contentNode,
Object value)`
  Sets the expando 'data-afr-lastvalue' to the element to store the last value.
  Parameters:

    `contentNode` | - | The element to which the last value must be set
    `value` | - | The last value to be set. This is optional parameter. If not passed, the current value of element is set as Last Value

  Return:
    `Object`

### ShouldShowHint

`protected Object ShouldShowHint(Object component,
Object domElement)`
  Show hints in note window for this component.
  Parameters:

    `component` |  |
    `domElement` |  |

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

### __simulateBlur

`Object __simulateBlur(Object comp)`
  Simulates blur handling in cases when we know that the focus is lost, but onBlur is not yet called (such as when onbeforeunload is delivered)
  Parameters:

    `comp` |  |

  Return:
    `Object`

### UpdateLastValue

`protected Object UpdateLastValue(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### VetoBlurValidation

`protected Object VetoBlurValidation()`
  Return:
    `Object`

### WasSubmitted

`protected Object WasSubmitted(Object component)`
  Returns false if blur event (which results in validation) is queued but focus is lost to a DOM element within the component itself.
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.WasSubmitted(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.