# 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.adf.view.js.event
Class AdfAutoCompletingEvent

    org.ecmascript.object.Object
       |
       +--oracle.adf.view.js.base.AdfObject
             |
             +--oracle.adf.view.js.event.AdfBaseEvent
                   |
                   +--oracle.adf.view.js.event.AdfPhasedEvent
                         |
                         +--oracle.adf.view.js.event.AdfComponentEvent
                               |
                               +--oracle.adf.view.js.event.AdfAutoCompletingEvent

    public class AdfAutoCompletingEvent
    extends AdfComponentEvent

The event is queued when auto-completion of an user typed value is being attempted. Cancelling this event will stop the auto-completion step.

## Field Summary
`private Object` | `_autoCompletedValue`
`private static Object` | `_EVENT_TYPE`
`private Object` | `_submittedValue`
`private Object` | `_vetoAutoCompletionError`

### Fields inherited from oracle.adf.view.js.event.AdfComponentEvent
`BLUR_EVENT_TYPE, CONTEXT_MENU_EVENT_TYPE, FOCUS_EVENT_TYPE`

### Fields inherited from oracle.adf.view.js.event.AdfBaseEvent
`AT_TARGET_PHASE, BUBBLING_PHASE, CAPTURING_PHASE`

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

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

## Constructor Summary
`public` | `AdfAutoCompletingEvent(Object source, Object submittedValue, Object autoCompletedValue)` The event is queued when auto-completion of an user typed value is being attempted.

## Method Summary
`public Object` | `getAutoCompletedValue()` Gets the autoCompletedValue parameter of the event
`public String` | `getSubmittedValue()` Gets the submittedValue parameter of the event
`protected Object` | `Init(Object source, Object submittedValue, Object autoCompletedValue)` Initializes the instance.
`public Boolean` | `isAutoCompletionSuppressed()` Gets whether the component should suppress the error message and invalidation upon auto-completion failure
`public static AdfAutoCompletingEvent` | `queue(Object component, String submittedValue, Object autoCompletedValue)` Convenience function for queueing an AdfAutoCompletingEvent on a component.
`public Object` | `vetoAutoCompletionError(Object shouldVeto)` Suppresses the error message when auto-completion fails on or blur, for any one of the following causes:

### Methods inherited from oracle.adf.view.js.event.AdfPhasedEvent
`getCurrentTarget, getDoesBubbles, getEventPhase, isCancelable, nextEventPhase, setCurrentTarget, toDebugString`

### Methods inherited from oracle.adf.view.js.event.AdfBaseEvent
`AddMarshalledProperties, cancel, forceFullSubmit, getClearMessages, getMaxTimeBeforePropagation, getProperties, getRoot, getShowMessages, getSource, getType, isBubblingStopped, isCanceled, IsDeleveryDiscrete, isDeliveryDiscrete, isFullSubmitForced, isImmediate, isPartial, isResponseAnnounced, isResponseExpected, IsUserInputPrevented, isValidationNeeded, noResponseExpected, preventUserInput, propagatesToServer, setPartial, setRoot, setSource, stopBubbling`

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

## Field Detail

### _autoCompletedValue

`private Object _autoCompletedValue`

### _EVENT_TYPE

`private static Object _EVENT_TYPE`

### _submittedValue

`private Object _submittedValue`

### _vetoAutoCompletionError

`private Object _vetoAutoCompletionError`

## Constructor Detail

### AdfAutoCompletingEvent

`public AdfAutoCompletingEvent(Object source,
Object submittedValue,
Object autoCompletedValue)`
  The event is queued when auto-completion of an user typed value is being attempted. Cancelling this event will stop the auto-completion step.
  Parameters:

    `source` |  |
    `submittedValue` |  |
    `autoCompletedValue` |  |

## Method Detail

### getAutoCompletedValue

`public Object getAutoCompletedValue()`
  Gets the autoCompletedValue parameter of the event
  Return:
    `Object` - autoCompletedValue

### getSubmittedValue

`public String getSubmittedValue()`
  Gets the submittedValue parameter of the event
  Return:
    `String` - submittedValue

### Init

`protected Object Init(Object source,
Object submittedValue,
Object autoCompletedValue)`
  Initializes the instance. Subclasses of AdfObject must call their superclass' Init
  Parameters:

    `source` |  |
    `submittedValue` |  |
    `autoCompletedValue` |  |

  Return:
    `Object`
  Overrides:
    `AdfObject.Init()`

### isAutoCompletionSuppressed

`public Boolean isAutoCompletionSuppressed()`
  Gets whether the component should suppress the error message and invalidation upon auto-completion failure
  Return:
    `Boolean` - True if auto-completion error is to be suppressed

### queue

`public static AdfAutoCompletingEvent queue(Object component,
String submittedValue,
Object autoCompletedValue)`
  Convenience function for queueing an AdfAutoCompletingEvent on a component.
  Parameters:

    `component` |  |
    `submittedValue` | - | the value that will be auto-completed
    `autoCompletedValue` | - | The auto-completed value of submittedValue

  Return:
    `AdfAutoCompletingEvent` - the event instance that was queued
  Overrides:
    `AdfComponentEvent.queue(Boolean)`

### vetoAutoCompletionError

`public Object vetoAutoCompletionError(Object shouldVeto)`
  Suppresses the error message when auto-completion fails on or blur, for any one of the following causes: 1. THe search query had no suggestions in the drop down 2. The user did not select any of the suggestions
  Parameters:

    `shouldVeto` |  |

  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.