Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-03


oracle.adf.view.rich.event
Class DropEvent

java.lang.Object
  extended by java.util.EventObject
      extended by oracle.adf.view.rich.event.DropEvent

All Implemented Interfaces:
java.io.Serializable

public abstract class DropEvent
extends java.util.EventObject

Object representing a drag and drop, drop on the client.

See Also:
Serialized Form

Nested Class Summary
static class DropEvent.DropOrientation
          Possible orientations that the drop might occur relative to the dropSite in the dropComponent.

 

Field Summary

 

Fields inherited from class java.util.EventObject
source

 

Constructor Summary
protected DropEvent(java.lang.Object source)
           

 

Method Summary
abstract  javax.faces.component.UIComponent getDragComponent()
          The UIComponent which initiated this drag operation.
abstract  DnDAction getDropAction()
          The DnDAction that the drop target actually performed.
abstract  javax.faces.component.UIComponent getDropComponent()
          The UIComponent on which the drop occurred.
abstract  DropEvent.DropOrientation getDropOrientation()
          Orientations relative to the dropSite for which the drop occurred.
abstract  java.lang.Object getDropSite()
          The drop-target-specific site within the drop component relative to which the drop occurred.
abstract  int getDropSiteIndex()
          Returns the index of the drop site for drop components that index their drop site, or -1 if the drop site doesn't exist or is unindexed.
abstract  int getDropX()
          The X coordinate of the drop, relative to the origin of the client drop component.
abstract  int getDropY()
          The Y coordinate of the drop, relative to the origin of the client drop component.
abstract  DnDAction getProposedAction()
          The DnDAction that the user requests the drop target perform as part of the drop
abstract  Transferable getTransferable()
          Returns the Transferable object containing the data available to the drop.

 

Methods inherited from class java.util.EventObject
getSource, toString

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

DropEvent

protected DropEvent(java.lang.Object source)

Method Detail

getDropComponent

public abstract javax.faces.component.UIComponent getDropComponent()
The UIComponent on which the drop occurred.
Returns:
UIComponent on which the drop occurred.

getDropSite

public abstract java.lang.Object getDropSite()
The drop-target-specific site within the drop component relative to which the drop occurred.

Please note that dropSite==null is a legal value for collection components. dropSite=null and DropOrientation==ON indicates that the drop has happened outside the data portion of the collection component and should be treated as a drop on the entire component Also note that dropSite==null and DropOrientation==AFTER indicates that the drop has happened on an empty collection component and the user intends to append the data.

Returns:
drop-target-specific site identifier relative to which the drop occurred.

getDropOrientation

public abstract DropEvent.DropOrientation getDropOrientation()
Orientations relative to the dropSite for which the drop occurred. Will be DropOrientation.ON for drop components with no internal drop site.
See Also:
getDropSite()

getDropSiteIndex

public abstract int getDropSiteIndex()
Returns the index of the drop site for drop components that index their drop site, or -1 if the drop site doesn't exist or is unindexed.
Returns:
index of the drop site within the drop compoennt.

getDropX

public abstract int getDropX()
The X coordinate of the drop, relative to the origin of the client drop component.

getDropY

public abstract int getDropY()
The Y coordinate of the drop, relative to the origin of the client drop component.

getProposedAction

public abstract DnDAction getProposedAction()
The DnDAction that the user requests the drop target perform as part of the drop

getTransferable

public abstract Transferable getTransferable()
Returns the Transferable object containing the data available to the drop.

getDropAction

public abstract DnDAction getDropAction()
The DnDAction that the drop target actually performed.

getDragComponent

public abstract javax.faces.component.UIComponent getDragComponent()
The UIComponent which initiated this drag operation.
Returns:
UIComponent which initiated this drag operation. Please note that there is no guarentee that this information always available, so this method can return null.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-03


Copyright (c) 1998, 2009, Oracle and/or its affiliates. All rights reserved.