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

## 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.dnd.AdfDnDContext
                   |
                   +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlDnDContext

    public class AdfDhtmlDnDContext
    extends AdfDnDContext

DHTML-specific implementation of AdfDnDContext for maintaining state of drag and drop operations

## Field Summary
`private static Object` | `_CAPTURE_MAP`
`private Object` | `_clearDrag`
`private static Object` | `_COPY_CURSOR`
`private Object` | `_dropTargetComponents`
`private static Object` | `_INHERIT_CURSOR`
`private Object` | `_isAndroid`
`private static Object` | `_LINK_CURSOR`
`private static Object` | `_MOVE_CURSOR`
`private static Object` | `_NOT_ALLOWED_CURSOR`

### Fields inherited from oracle.adf.view.js.dnd.AdfDnDContext
`ACTION_COPY, ACTION_COPY_OR_MOVE, ACTION_LINK, ACTION_MOVE, ACTION_NONE, ACTIONS_ALL`

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

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

## Constructor Summary
`public` | `AdfDhtmlDnDContext()` DHTML-specific implementation of AdfDnDContext for maintaining state of drag and drop operations

## Method Summary
`private static Object` | `_abortCallback(Object event)` Aborts the current drag
`private Object` | `_abortDrag()` Called to abort the current drag
`private Object` | `_abortEvent(Object event)` Aborts the drag and eats the event
`private static Object` | `_abortIfOutsideWindowCallback(Object event)` Aborts the drag and eats the event if the drag is outside of the window
`private Object` | `_acceptDrag(Object dropTarget, Object event, Object dropTargetFuncName, Object mousePage)` Update the drag options based on the current keyboard modifiers
`Object` | `__addComponentTarget(Object component)` Adds a component with a AdfDropTarget
`private static Object` | `_autoscrollCallback()` Establish this before calling _autoscroll callback
`private Object` | `_changeActiveDropCSSClass(Object dropTarget, Boolean addClass)` adds/removes the active target CSS class name from the DropTarget
`private Object` | `_checkAbort(Object event)`
`private static Object` | `_checkAbortCallback(Object event)` Establish this before calling _checkAbort callback
`private Object` | `_clearDrag()`
`private Object` | `_doDrop(Object event)`
`private static Object` | `_doDropCallback(Object event)` Establish this before calling _doDrop callback
`private Object` | `_dragComplete(Object mouseReleased)` Cleans up after completion of a drag.
`private Object` | `_findContainingDragSource(Object inputEvent)` Finds the closest AdfDragSource capable of starting a drag for this inputEvent
`private Object` | `_findDragSource(Object inputEvent)` Find the AdfDragSource containing the event
`private Object` | `_findDropTarget(Object oldDropTarget, Object pageX, Object pageY)`
`private Object` | `_getCaptureMap()` Get the map of events to methods to invoke during a drag operation.
`private Object` | `_getDragDiv()` Lazily creates the floating DIV to drag around
`public Object` | `getDragSource()` Returns the AdfDragSource that initiated the drag.
`public Object` | `getDropTargetProperty(Object name)` Gets a property for the current Drop target.
`public Object` | `getSourceActions()` returns the current actions allowed by the source
`public AdfTransferable` | `getTransferable()` Returns the AdfTransferable currently being dragged.
`public Object` | `getTriggerEvent()` Returns the AdfAdfUIInputEvent that initiated the drag
`public Object` | `getUserAction()` Returns the current action chosen by the user
`Object` | `__handleInputEvent(Object inputEvent)` Handles distributing AdfAdfUIInputEvents to the drag and drop framework
`protected Object` | `Init()` Initializes the instance.
`protected static Object` | `InitClass()`
`public Object` | `isDragging()` Returns true if the user is currently dragging.
`boolean` | `__isDragPrepped()`
`private static Object` | `_pointInDropTarget(Object component, Object pageX, Object pageY)`
`Object` | `__removeComponentTarget(Object component)` Remove a component with a AdfDropTarget
`Object` | `__removeDragSource(Object component)` If there is a drag source associated with a component clear it
`private Object` | `_setCursor(Object newCursor)` Set the cursor
`public Object` | `setDropTargetProperty(Object name, Object value)` Sets a property for the current Drop target.
`private Object` | `_setUserAction(Object newUserAction, Object deliverDropActionChanged)`
`public Object` | `startDrag(Object triggerEvent, Object transferable, Object allowedActions, Object defaultAction, Object dragOverNode, Object cursorOffsetX, Object cursorOffsetY, Object cursor)` Actually starts a drag
`public Object` | `toDebugString()`
`private Object` | `_trackDrag(Object event)` Update the drag feedback
`private static Object` | `_trackDragCallback(Object event)` Establish this before calling _trackDrag callback
`private static Object` | `_updateDragOptionsCallback(Object event)` Establish this before calling _acceptDrag callback

### Methods inherited from oracle.adf.view.js.dnd.AdfDnDContext
`assertUserAction`

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

## Field Detail

### _CAPTURE_MAP

`private static Object _CAPTURE_MAP`

### _clearDrag

`private Object _clearDrag`

### _COPY_CURSOR

`private static Object _COPY_CURSOR`

### _dropTargetComponents

`private Object _dropTargetComponents`

### _INHERIT_CURSOR

`private static Object _INHERIT_CURSOR`

### _isAndroid

`private Object _isAndroid`

### _LINK_CURSOR

`private static Object _LINK_CURSOR`

### _MOVE_CURSOR

`private static Object _MOVE_CURSOR`

### _NOT_ALLOWED_CURSOR

`private static Object _NOT_ALLOWED_CURSOR`

## Constructor Detail

### AdfDhtmlDnDContext

`public AdfDhtmlDnDContext()`
  DHTML-specific implementation of AdfDnDContext for maintaining state of drag and drop operations

## Method Detail

### _abortCallback

`private static Object _abortCallback(Object event)`
  Aborts the current drag
  Parameters:

    `event` |  |

  Return:
    `Object`

### _abortDrag

`private Object _abortDrag()`
  Called to abort the current drag
  Return:
    `Object`

### _abortEvent

`private Object _abortEvent(Object event)`
  Aborts the drag and eats the event
  Parameters:

    `event` |  |

  Return:
    `Object`

### _abortIfOutsideWindowCallback

`private static Object _abortIfOutsideWindowCallback(Object event)`
  Aborts the drag and eats the event if the drag is outside of the window
  Parameters:

    `event` |  |

  Return:
    `Object`

### _acceptDrag

`private Object _acceptDrag(Object dropTarget,
Object event,
Object dropTargetFuncName,
Object mousePage)`
  Update the drag options based on the current keyboard modifiers
  Parameters:

    `dropTarget` |  |
    `event` |  |
    `dropTargetFuncName` |  |
    `mousePage` |  |

  Return:
    `Object`

### __addComponentTarget

`Object __addComponentTarget(Object component)`
  Adds a component with a AdfDropTarget
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfDnDContext.__addComponentTarget(Object)`

### _autoscrollCallback

`private static Object _autoscrollCallback()`
  Establish this before calling _autoscroll callback
  Return:
    `Object`

### _changeActiveDropCSSClass

`private Object _changeActiveDropCSSClass(Object dropTarget,
Boolean addClass)`
  adds/removes the active target CSS class name from the DropTarget
  Parameters:

    `dropTarget` |  |
    `addClass` | - | `true` if we should add the drop target CSS class, `false` if we should remove it

  Return:
    `Object`

### _checkAbort

`private Object _checkAbort(Object event)`
  Parameters:

    `event` |  |

  Return:
    `Object`

### _checkAbortCallback

`private static Object _checkAbortCallback(Object event)`
  Establish this before calling _checkAbort callback
  Parameters:

    `event` |  |

  Return:
    `Object`

### _clearDrag

`private Object _clearDrag()`
  Return:
    `Object`

### _doDrop

`private Object _doDrop(Object event)`
  Parameters:

    `event` |  |

  Return:
    `Object`

### _doDropCallback

`private static Object _doDropCallback(Object event)`
  Establish this before calling _doDrop callback
  Parameters:

    `event` |  |

  Return:
    `Object`

### _dragComplete

`private Object _dragComplete(Object mouseReleased)`
  Cleans up after completion of a drag.
  Parameters:

    `mouseReleased` | - | Boolean indicating whether the mouse has been released. We need to a bit of extra work if the mouse is still held down.

  Return:
    `Object`

### _findContainingDragSource

`private Object _findContainingDragSource(Object inputEvent)`
  Finds the closest AdfDragSource capable of starting a drag for this inputEvent
  Parameters:

    `inputEvent` |  |

  Return:
    `Object`

### _findDragSource

`private Object _findDragSource(Object inputEvent)`
  Find the AdfDragSource containing the event
  Parameters:

    `inputEvent` |  |

  Return:
    `Object`

### _findDropTarget

`private Object _findDropTarget(Object oldDropTarget,
Object pageX,
Object pageY)`
  Parameters:

    `oldDropTarget` |  |
    `pageX` |  |
    `pageY` |  |

  Return:
    `Object`

### _getCaptureMap

`private Object _getCaptureMap()`
  Get the map of events to methods to invoke during a drag operation.
  Return:
    `Object`

### _getDragDiv

`private Object _getDragDiv()`
  Lazily creates the floating DIV to drag around
  Return:
    `Object`

### getDragSource

`public Object getDragSource()`
  Returns the AdfDragSource that initiated the drag.
  Return:
    `Object`
  Overrides:
    `AdfDnDContext.getDragSource()`

### getDropTargetProperty

`public Object getDropTargetProperty(Object name)`
  Gets a property for the current Drop target. The properties are cleared whenever a drop target is exited
  Parameters:

    `name` |  |

  Return:
    `Object`
  Overrides:
    `AdfDnDContext.getDropTargetProperty(Object)`

### getSourceActions

`public Object getSourceActions()`
  returns the current actions allowed by the source
  Return:
    `Object`
  Overrides:
    `AdfDnDContext.getSourceActions()`

### getTransferable

`public AdfTransferable getTransferable()`
  Returns the AdfTransferable currently being dragged.
  Return:
    `AdfTransferable` - null
  Overrides:
    `AdfDnDContext.getTransferable()`

### getTriggerEvent

`public Object getTriggerEvent()`
  Returns the AdfAdfUIInputEvent that initiated the drag
  Return:
    `Object`
  Overrides:
    `AdfDnDContext.getTriggerEvent()`

### getUserAction

`public Object getUserAction()`
  Returns the current action chosen by the user
  Return:
    `Object`
  Overrides:
    `AdfDnDContext.getUserAction()`

### __handleInputEvent

`Object __handleInputEvent(Object inputEvent)`
  Handles distributing AdfAdfUIInputEvents to the drag and drop framework
  Parameters:

    `inputEvent` |  |

  Return:
    `Object`

### Init

`protected Object Init()`
  Initializes the instance. Subclasses of AdfObject must call their superclass' Init
  Return:
    `Object`
  Overrides:
    `AdfObject.Init()`

### InitClass

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

### isDragging

`public Object isDragging()`
  Returns true if the user is currently dragging.
  Return:
    `Object`
  Overrides:
    `AdfDnDContext.isDragging()`

### __isDragPrepped

`boolean __isDragPrepped()`
  Return:
    `boolean` - Returns true if the drag prep context has been created.
  See also:
    `AdfDragRecognizer.prepDrag(Object, Object, Object)`
    `AdfSafariTouchContextMenuManager.deriveContextMenuEvent(AdfComponentEvent)`

### _pointInDropTarget

`private static Object _pointInDropTarget(Object component,
Object pageX,
Object pageY)`
  Parameters:

    `component` |  |
    `pageX` |  |
    `pageY` |  |

  Return:
    `Object`

### __removeComponentTarget

`Object __removeComponentTarget(Object component)`
  Remove a component with a AdfDropTarget
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfDnDContext.__removeComponentTarget(Object)`

### __removeDragSource

`Object __removeDragSource(Object component)`
  If there is a drag source associated with a component clear it
  Parameters:

    `component` |  |

  Return:
    `Object`

### _setCursor

`private Object _setCursor(Object newCursor)`
  Set the cursor
  Parameters:

    `newCursor` |  |

  Return:
    `Object`

### setDropTargetProperty

`public Object setDropTargetProperty(Object name,
Object value)`
  Sets a property for the current Drop target. The properties are cleared whenever a drop target is exited
  Parameters:

    `name` |  |
    `value` |  |

  Return:
    `Object`
  Overrides:
    `AdfDnDContext.setDropTargetProperty(Object, Object)`

### _setUserAction

`private Object _setUserAction(Object newUserAction,
Object deliverDropActionChanged)`
  Parameters:

    `newUserAction` |  |
    `deliverDropActionChanged` |  |

  Return:
    `Object`

### startDrag

`public Object startDrag(Object triggerEvent,
Object transferable,
Object allowedActions,
Object defaultAction,
Object dragOverNode,
Object cursorOffsetX,
Object cursorOffsetY,
Object cursor)`
  Actually starts a drag
  Parameters:

    `triggerEvent` |  |
    `transferable` |  |
    `allowedActions` |  |
    `defaultAction` |  |
    `dragOverNode` |  |
    `cursorOffsetX` |  |
    `cursorOffsetY` |  |
    `cursor` |  |

  Return:
    `Object`
  Overrides:
    `AdfDnDContext.startDrag(Object, Object, Object, Object, Object, Object, Object, Object)`

### toDebugString

`public Object toDebugString()`
  Return:
    `Object`
  Overrides:
    `AdfObject.toDebugString()`

### _trackDrag

`private Object _trackDrag(Object event)`
  Update the drag feedback
  Parameters:

    `event` |  |

  Return:
    `Object`

### _trackDragCallback

`private static Object _trackDragCallback(Object event)`
  Establish this before calling _trackDrag callback
  Parameters:

    `event` |  |

  Return:
    `Object`

### _updateDragOptionsCallback

`private static Object _updateDragOptionsCallback(Object event)`
  Establish this before calling _acceptDrag callback
  Parameters:

    `event` |  |

  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.