public abstract class DropEvent extends EventObject
Modifier and Type | Class and Description |
---|---|
static class |
DropEvent.DropOrientation
Possible orientations that the drop might occur relative to the
dropSite in the dropComponent . |
source
Modifier | Constructor and Description |
---|---|
protected |
DropEvent(Object source) |
Modifier and Type | Method and Description |
---|---|
String |
getDragClientId()
The clientId of the component that initiated this drag operation.
|
abstract javax.faces.component.UIComponent |
getDragComponent()
The UIComponent which initiated this drag operation.
|
abstract DnDAction |
getDropAction()
The DnDAction that the drop target actually performed.
|
String |
getDropClientId()
The clientId of the UIComponent on which the drop occurred.
|
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 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.
|
getSource, toString
protected DropEvent(Object source)
public abstract javax.faces.component.UIComponent getDropComponent()
getDropClientId()
public String getDropClientId()
getDropComponent()
, UIComponent.invokeOnComponent(javax.faces.context.FacesContext, java.lang.String, javax.faces.component.ContextCallback)
, UIComponent.visitTree(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)
public abstract Object getDropSite()
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.
public abstract DropEvent.DropOrientation getDropOrientation()
dropSite
for which the drop occurred. Will be DropOrientation.ON
for drop components with no internal drop site.getDropSite()
public abstract int getDropSiteIndex()
public abstract int getDropX()
public abstract int getDropY()
public abstract DnDAction getProposedAction()
public abstract Transferable getTransferable()
public abstract DnDAction getDropAction()
public abstract javax.faces.component.UIComponent getDragComponent()
getDragClientId()
public String getDragClientId()
getDragComponent()
, UIComponent.invokeOnComponent(javax.faces.context.FacesContext, java.lang.String, javax.faces.component.ContextCallback)
, UIComponent.visitTree(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)