Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.DropZone.Builder< TDropZone, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.DropZone.Builder< TDropZone, TBuilder >:
Ext.Net.DropTarget.Builder< TDropZone, TBuilder >

Public Member Functions

 Builder (TDropZone component)
 
virtual TBuilder GetTargetFromEvent (Action< JFunction > action)
 Returns a custom data object associated with the DOM node that is the target of the event. By default this looks up the event target in the Ext.dd.Registry, although you can override this method to provide your own custom lookup. More...
 
virtual TBuilder OnContainerDrop (Action< JFunction > action)
 Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it, but not on any of its registered drop nodes. The default implementation returns false, so it should be overridden to provide the appropriate processing of the drop event if you need the drop zone itself to be able to accept drops. It should return true when valid so that the drag source's repair action does not run. More...
 
virtual TBuilder OnContainerOver (Action< JFunction > action)
 Called while the DropZone determines that a Ext.dd.DragSource is being dragged over it, but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so it should be overridden to provide the proper feedback if necessary. More...
 
virtual TBuilder OnNodeDrop (Action< JFunction > action)
 Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto the drop node. The default implementation returns false, so it should be overridden to provide the appropriate processing of the drop event and return true so that the drag source's repair action does not run. More...
 
virtual TBuilder OnNodeEnter (Action< JFunction > action)
 Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node that has either been registered or detected by a configured implementation of getTargetFromEvent. This method has no default implementation and should be overridden to provide node-specific processing if necessary. More...
 
virtual TBuilder OnNodeOut (Action< JFunction > action)
 Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of the drop node without dropping. This method has no default implementation and should be overridden to provide node-specific processing if necessary. More...
 
virtual TBuilder OnNodeOver (Action< JFunction > action)
 Called while the DropZone determines that a Ext.dd.DragSource is over a drop node that has either been registered or detected by a configured implementation of getTargetFromEvent. The default implementation returns this.dropNotAllowed, so it should be overridden to provide the proper feedback. More...
 
 Builder ()
 
 Builder (DropZone component)
 
 Builder (DropZone.Config config)
 
- Public Member Functions inherited from Ext.Net.DropTarget.Builder< TDropZone, TBuilder >
 Builder (TDropTarget component)
 
 Builder ()
 
 Builder (DropTarget component)
 
 Builder (DropTarget.Config config)
 
virtual TBuilder Group (string group)
 A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to undefined). More...
 
virtual TBuilder DropAllowed (string dropAllowed)
 The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). More...
 
virtual TBuilder DropNotAllowed (string dropNotAllowed)
 The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). More...
 
virtual TBuilder OverClass (string overClass)
 The CSS class applied to the drop target element while the drag source is over it (defaults to ""). More...
 
virtual TBuilder ContainerScroll (bool containerScroll)
 True to register this container with the Scrollmanager for auto scrolling during drag operations. More...
 
virtual TBuilder NotifyDrop (Action< JFunction > action)
 The function a Ext.dd.DragSource calls once to notify this drop target that the dragged item has been dropped on it. This method has no default implementation and returns false, so you must provide an implementation that does something to process the drop event and returns true so that the drag source's repair action does not run. More...
 
virtual TBuilder NotifyEnter (Action< JFunction > action)
 The function a Ext.dd.DragSource calls once to notify this drop target that the source is now over the target. This default implementation adds the CSS class specified by overClass (if any) to the drop element and returns the dropAllowed config value. This method should be overridden if drop validation is required. More...
 
virtual TBuilder NotifyOut (Action< JFunction > action)
 The function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged out of the target without dropping. This default implementation simply removes the CSS class specified by overClass (if any) from the drop element. More...
 
virtual TBuilder NotifyOver (Action< JFunction > action)
 The function a Ext.dd.DragSource calls continuously while it is being dragged over the target. This method will be called on every mouse movement while the drag source is over the drop target. This default implementation simply returns the dropAllowed config value. More...
 

Static Public Member Functions

static implicit operator Builder (DropZone component)
 
- Static Public Member Functions inherited from Ext.Net.DropTarget.Builder< TDropZone, TBuilder >
static implicit operator Builder (DropTarget component)
 

Detailed Description

Type Constraints
TDropZone :DropZone 
TBuilder :Builder 
TBuilder :TDropZone 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.DropZone.Builder< TDropZone, TBuilder >.Builder ( TDropZone  component)
inline

◆ Builder() [2/4]

Ext.Net.DropZone.Builder< TDropZone, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.DropZone.Builder< TDropZone, TBuilder >.Builder ( DropZone  component)
inline

◆ Builder() [4/4]

Ext.Net.DropZone.Builder< TDropZone, TBuilder >.Builder ( DropZone.Config  config)
inline

Member Function Documentation

◆ GetTargetFromEvent()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.GetTargetFromEvent ( Action< JFunction action)
inlinevirtual

Returns a custom data object associated with the DOM node that is the target of the event. By default this looks up the event target in the Ext.dd.Registry, although you can override this method to provide your own custom lookup.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnContainerDrop()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.OnContainerDrop ( Action< JFunction action)
inlinevirtual

Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it, but not on any of its registered drop nodes. The default implementation returns false, so it should be overridden to provide the appropriate processing of the drop event if you need the drop zone itself to be able to accept drops. It should return true when valid so that the drag source's repair action does not run.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnContainerOver()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.OnContainerOver ( Action< JFunction action)
inlinevirtual

Called while the DropZone determines that a Ext.dd.DragSource is being dragged over it, but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so it should be overridden to provide the proper feedback if necessary.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnNodeDrop()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.OnNodeDrop ( Action< JFunction action)
inlinevirtual

Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto the drop node. The default implementation returns false, so it should be overridden to provide the appropriate processing of the drop event and return true so that the drag source's repair action does not run.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnNodeEnter()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.OnNodeEnter ( Action< JFunction action)
inlinevirtual

Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node that has either been registered or detected by a configured implementation of getTargetFromEvent. This method has no default implementation and should be overridden to provide node-specific processing if necessary.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnNodeOut()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.OnNodeOut ( Action< JFunction action)
inlinevirtual

Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of the drop node without dropping. This method has no default implementation and should be overridden to provide node-specific processing if necessary.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnNodeOver()

virtual TBuilder Ext.Net.DropZone.Builder< TDropZone, TBuilder >.OnNodeOver ( Action< JFunction action)
inlinevirtual

Called while the DropZone determines that a Ext.dd.DragSource is over a drop node that has either been registered or detected by a configured implementation of getTargetFromEvent. The default implementation returns this.dropNotAllowed, so it should be overridden to provide the proper feedback.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ operator Builder()

static implicit Ext.Net.DropZone.Builder< TDropZone, TBuilder >.operator Builder ( DropZone  component)
inlinestatic


The documentation for this class was generated from the following file: