JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.dnd
Class AdfStampedDropTarget

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.AdfDropTarget
               |
               +--oracle.adfinternal.view.js.dnd.AdfStampedDropTarget

Direct Known Subclasses:

AdfDashboardDropTarget, AdfTableDropTarget

public class AdfStampedDropTarget
extends AdfDropTarget

Abstract AdfDropTarget, supporting drops onto stamped components.

Field Summary

private static Object	_ACTION_KEYS
private Object	_allowedActions
private static Object	_BOUNDS_KEY
public static Object	DROP_ORIENTATION
public static Object	HINT_LAST_DROP_ORIENTATION
public static Object	HINT_LAST_ROWKEY
public static Object	HINT_LAST_ROWKEY_BOUNDS
private Object	_modelName
private static Object	_NULL_ROW_KEY
public static Object	ROW_KEY
private static Object	_ROWKEY_HINTS

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfStampedDropTarget(Number allowedActions, String modelName) Abstract AdfDropTarget, supporting drops onto stamped components.

Method Summary

protected Object	AcceptDrag(Object dndContext, Object possibleActions, Object proposedAction, Object pageX, Object pageY) Override to cache acceptance results based on rowKey/proposedAction combination
protected Object	AcceptDragOverrideIfRejectedByFlavor(AdfDnDContext dndContext, Object originalProposedAction) If the AcceptDrag was determined to use AdfDnDContext.ACTION_NONE based upon data flavor, this function can be overridden to provide exceptions for accepting the drag such as if the drop target supports child reordering.
private Object	_cleanUpDragFeedback(Object dndContext, Object dragExit)
public Object	dragExit(Object dndContext) Called while a drag operation is ongoing, when the mouse pointer has exited the operable part of the drop site for the AdfDropTarget.
public Object	drop(Object dndContext, Object proposedAction, Object pageX, Object pageY) Called when the drag operation has terminated with a drop on the operable part of the drop site for the AdfDropTarget
protected Object	DropOnRowKey(Object dndContext, Object proposedAction, Object pageX, Object pageY, Object rowKey, Object dropOrientation) Override for the subclassed drop target to perform an action on the drop of rowkey.
protected Object	GetAllowedActions(Object dndContext) Override to use the actions specified by the developer
protected Object	GetAllowedFlavors(Object dndContext) Returns the Array of allowed AdfDataFlavors.
public Object	getRowKeyDataFlavor() Returns the type of RowKey AdfDataFlavor used by this StampedAdfDropTarget
protected Object	Init(Object allowedActions, Object modelName) Initializes the instance.
protected Object	NeedsRowKeyCollectionCheck() Returns whether a special check against the row keys is needed.
public Object	toDebugString()

Methods inherited from oracle.adf.view.js.dnd.AdfDropTarget

acceptDragEnter, acceptDragOver, acceptDropActionChanged, AcceptedDragEnter, CalculateFlavorAcceptance, getComponent

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toString

Field Detail

_ACTION_KEYS

private static Object _ACTION_KEYS

_allowedActions

private Object _allowedActions

_BOUNDS_KEY

private static Object _BOUNDS_KEY

DROP_ORIENTATION

public static Object DROP_ORIENTATION

HINT_LAST_DROP_ORIENTATION

public static Object HINT_LAST_DROP_ORIENTATION

HINT_LAST_ROWKEY

public static Object HINT_LAST_ROWKEY

HINT_LAST_ROWKEY_BOUNDS

public static Object HINT_LAST_ROWKEY_BOUNDS

_modelName

private Object _modelName

_NULL_ROW_KEY

private static Object _NULL_ROW_KEY

ROW_KEY

public static Object ROW_KEY

_ROWKEY_HINTS

private static Object _ROWKEY_HINTS

Constructor Detail

AdfStampedDropTarget

public AdfStampedDropTarget(Number allowedActions,
String modelName)

Abstract AdfDropTarget, supporting drops onto stamped components.

Parameters:

allowedActions	-	that can be performed by this drop target
modelName	-	used to identify this dropTarget

Method Detail

AcceptDrag

protected Object AcceptDrag(Object dndContext,
Object possibleActions,
Object proposedAction,
Object pageX,
Object pageY)

Override to cache acceptance results based on rowKey/proposedAction combination

Parameters:

dndContext
possibleActions
proposedAction
pageX
pageY

Return:

Object

Overrides:

AdfDropTarget.AcceptDrag(Object, Object, Object, Object, Object)

AcceptDragOverrideIfRejectedByFlavor

protected Object AcceptDragOverrideIfRejectedByFlavor(AdfDnDContext dndContext,
Object originalProposedAction)

If the AcceptDrag was determined to use AdfDnDContext.ACTION_NONE based upon data flavor, this function can be overridden to provide exceptions for accepting the drag such as if the drop target supports child reordering.

Parameters:

dndContext	-	the AdfDnDContext
originalProposedAction	-	the originally-proposed AdfDnDContext action type

Return:

Object - an AdfDnDContext action type

_cleanUpDragFeedback

private Object _cleanUpDragFeedback(Object dndContext,
Object dragExit)

Parameters:

dndContext
dragExit

Return:

Object

dragExit

public Object dragExit(Object dndContext)

Called while a drag operation is ongoing, when the mouse pointer has exited the operable part of the drop site for the AdfDropTarget.

Parameters:

dndContext

Return:

Object

Overrides:

AdfDropTarget.dragExit(Object)

drop

public Object drop(Object dndContext,
Object proposedAction,
Object pageX,
Object pageY)

Called when the drag operation has terminated with a drop on the operable part of the drop site for the AdfDropTarget

Parameters:

dndContext
proposedAction
pageX
pageY

Return:

Object

Overrides:

AdfDropTarget.drop(AdfDnDContext, Object, Number, Number)

DropOnRowKey

protected Object DropOnRowKey(Object dndContext,
Object proposedAction,
Object pageX,
Object pageY,
Object rowKey,
Object dropOrientation)

Override for the subclassed drop target to perform an action on the drop of rowkey. The default implementation queues the drop event with the rowkey as the dropSite.

Parameters:

dndContext
proposedAction
pageX
pageY
rowKey
dropOrientation

Return:

Object

GetAllowedActions

protected Object GetAllowedActions(Object dndContext)

Override to use the actions specified by the developer

Parameters:

dndContext

Return:

Object

Overrides:

AdfDropTarget.GetAllowedActions(Object)

GetAllowedFlavors

protected Object GetAllowedFlavors(Object dndContext)

Returns the Array of allowed AdfDataFlavors. If subclasses plan to use the default implementation of AcceptDrag, they must override this method to return their support AdfDataFlavors.

Parameters:

dndContext

Return:

Object

Overrides:

AdfDropTarget.GetAllowedFlavors(Object)

getRowKeyDataFlavor

public Object getRowKeyDataFlavor()

Returns the type of RowKey AdfDataFlavor used by this StampedAdfDropTarget

Return:

Object

Init

protected Object Init(Object allowedActions,
Object modelName)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:

allowedActions
modelName

Return:

Object

Overrides:

AdfObject.Init()

NeedsRowKeyCollectionCheck

protected Object NeedsRowKeyCollectionCheck()

Returns whether a special check against the row keys is needed.

Return:

Object - true if a special check against the row keys is needed

toDebugString

public Object toDebugString()

Return:

Object

Overrides:

AdfObject.toDebugString()

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD