JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.dnd
Class AdfDnDContext

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.dnd.AdfDnDContext

Direct Known Subclasses:

AdfDhtmlDnDContext

public class AdfDnDContext
extends AdfObject

ACTION_COPY

public static Object ACTION_COPY

Constant flag indicating that the COPY Drop operation is available

ACTION_COPY_OR_MOVE

public static Object ACTION_COPY_OR_MOVE

Convenience constant indicating that both the COPY and MOVE Drop operations are available

ACTION_LINK

public static Object ACTION_LINK

Constant flag indicating that the LINK Drop operation is available

ACTION_MOVE

public static Object ACTION_MOVE

Constant flag indicating that the MOVE Drop operation is available

ACTION_NONE

public static Object ACTION_NONE

Constant indicating that no Drop operation is available

ACTIONS_ALL

public static Object ACTIONS_ALL

Convenience constant indicating that all Drop operations are available

_VALID_USER_ACTIONS

private static Object _VALID_USER_ACTIONS

AdfDnDContext

public AdfDnDContext()

Abstract Context object managing Drag and Drop operations

__addComponentTarget

Object __addComponentTarget(Object component)

Adds a component with a AdfDropTarget

Parameters:

component

Return:

Object

assertUserAction

public static Object assertUserAction(Object userAction)

AdfAsserts that the user action is valid

Parameters:

userAction

Return:

Object

getDragSource

public Object getDragSource()

Returns the AdfDragSource that initiated the drag.

Return:

Object

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

getSourceActions

public Object getSourceActions()

returns the current actions allowed by the source

Return:

Object

getTransferable

public Object getTransferable()

Returns the AdfTransferable currently being dragged.

Return:

Object

getTriggerEvent

public Object getTriggerEvent()

Returns the AdfAdfUIInputEvent that initiated the drag

Return:

Object

getUserAction

public Object getUserAction()

Returns the current action chosen by the user

Return:

Object

isDragging

public Object isDragging()

Returns true if the user is currently dragging.

Return:

Object

__removeComponentTarget

Object __removeComponentTarget(Object component)

Remove a component with a AdfDropTarget

Parameters:

component

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

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