Inheritance diagram for Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >:

Public Member Functions
	Builder (TDragDrop component)

virtual TBuilder	DefaultPadding (Action< Paddings > action)
	Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). More...

virtual TBuilder	Groups (Action< DragDropGroups > action)
	The group defines a logical collection of DragDrop objects that are related. Instances only get events when interacting with other DragDrop object in the same group. This lets us define multiple groups using a single DragDrop subclass if we want. More...

virtual TBuilder	HasOuterHandles (bool hasOuterHandles)
	By default, drags can only be initiated if the mousedown occurs in the region the linked element is. This is done in part to work around a bug in some browsers that mis-report the mousedown if the previous mouseup happened outside of the window. This property is set to true if outer handles are defined. More...

virtual TBuilder	Target (string target)
	The id of the element associated with this object. This is what we refer to as the "linked element" because the size and position of this element is used to determine when the drag and drop objects have interacted. More...

virtual TBuilder	Group (string group)
	The group of related DragDrop objects More...

virtual TBuilder	IgnoreSelf (bool ignoreSelf)
	Set to false to enable a DragDrop object to fire drag events while dragging over its own Element. Defaults to true - DragDrop objects do not by default fire drag events to themselves. More...

virtual TBuilder	InvalidHandleClasses (string[] invalidHandleClasses)
	An Array of CSS class names for elements to be considered in valid as drag handles. More...

virtual TBuilder	InvalidHandleTypes (string[] invalidHandleTypes)
	An array who's items identify HTML tags to be considered invalid as drag handles. More...

virtual TBuilder	InvalidHandleIds (string[] invalidHandleIds)
	An array who's items identify the IDs of elements to be considered invalid as drag handles More...

virtual TBuilder	IsTarget (bool isTarget)
	By default, all instances can be a drop target. This can be disabled by setting isTarget to false. More...

virtual TBuilder	MaintainOffset (bool maintainOffset)
	Maintain offsets when we resetconstraints. Set to true when you want the position of the element relative to its parent to stay the same when the page changes More...

virtual TBuilder	MoveOnly (bool moveOnly)
	When set to true, other DD objects in cooperating DDGroups do not receive notification events when this DD object is dragged over them. Defaults to false. More...

virtual TBuilder	Padding (int[] padding)
	The padding configured for this drag and drop object for calculating the drop zone intersection with this object. An array containing the 4 padding values: [top, right, bottom, left] More...

virtual TBuilder	PrimaryButtonOnly (bool primaryButtonOnly)
	By default the drag and drop instance will only respond to the primary button click (left button for a right-handed mouse). Set to true to allow drag and drop to start with any mouse click that is propogated by the browser More...

virtual TBuilder	XTicks (int[] xTicks)
	Array of pixel locations the element will snap to if we specified a horizontal graduation/interval. This array is generated automatically when you define a tick interval. More...

virtual TBuilder	YTicks (int[] yTicks)
	Array of pixel locations the element will snap to if we specified a vertical graduation/interval. This array is generated automatically when you define a tick interval. More...

virtual TBuilder	GetDragEl (Action< JFunction > action)
	Returns a reference to the actual element to drag. By default this is the same as the html element, but it can be assigned to another element. An example of this can be found in Ext.dd.DDProxy More...

virtual TBuilder	EndDrag (Action< JFunction > action)
	Fired when we are done dragging the object More...

virtual TBuilder	OnAvailable (Action< JFunction > action)
	Override the onAvailable method to do what is needed after the initial position was determined. More...

virtual TBuilder	OnDrag (Action< JFunction > action)
	Abstract method called during the onMouseMove event while dragging an object. More...

virtual TBuilder	OnDragDrop (Action< JFunction > action)
	Abstract method called when this item is dropped on another DragDrop obj More...

virtual TBuilder	OnDragEnter (Action< JFunction > action)
	Abstract method called when this element fist begins hovering over another DragDrop obj More...

virtual TBuilder	OnDragOut (Action< JFunction > action)
	Abstract method called when we are no longer hovering over an element More...

virtual TBuilder	OnDragOver (Action< JFunction > action)
	Abstract method called when this element is hovering over another DragDrop obj More...

virtual TBuilder	OnInvalidDrop (Action< JFunction > action)
	Abstract method called when this item is dropped on an area with no drop target More...

virtual TBuilder	OnMouseDown (Action< JFunction > action)
	Event handler that fires when a drag/drop obj gets a mousedown More...

virtual TBuilder	OnMouseUp (Action< JFunction > action)
	Event handler that fires when a drag/drop obj gets a mouseup More...

virtual TBuilder	StartDrag (Action< JFunction > action)
	Event handler that fires when a drag/drop obj gets a mouseup More...

virtual TBuilder	B4Drag (Action< JFunction > action)
	Code that executes immediately before the onDrag event More...

virtual TBuilder	B4DragDrop (Action< JFunction > action)
	Code that executes immediately before the onDragDrop event More...

virtual TBuilder	B4DragOut (Action< JFunction > action)
	Code that executes immediately before the onDragOut event More...

virtual TBuilder	B4DragOver (Action< JFunction > action)
	Code that executes immediately before the onDragOver event More...

virtual TBuilder	B4EndDrag (Action< JFunction > action)
	Code that executes immediately before the endDrag event More...

virtual TBuilder	B4MouseDown (Action< JFunction > action)
	Code executed immediately before the onMouseDown event More...

virtual TBuilder	B4StartDrag (Action< JFunction > action)
	Code that executes immediately before the startDrag event More...

Detailed Description

Type Constraints

TDragDrop	:	DragDrop
TBuilder	:	Builder
TBuilder	:	TDragDrop
TBuilder	:	TBuilder

Constructor & Destructor Documentation

◆ Builder()

Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.Builder ( TDragDrop component )

inline

Member Function Documentation

◆ B4Drag()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4Drag ( Action< JFunction > action )

inlinevirtual

Code that executes immediately before the onDrag event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ B4DragDrop()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4DragDrop ( Action< JFunction > action )

inlinevirtual

Code that executes immediately before the onDragDrop event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ B4DragOut()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4DragOut ( Action< JFunction > action )

inlinevirtual

Code that executes immediately before the onDragOut event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ B4DragOver()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4DragOver ( Action< JFunction > action )

inlinevirtual

Code that executes immediately before the onDragOver event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ B4EndDrag()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4EndDrag ( Action< JFunction > action )

inlinevirtual

Code that executes immediately before the endDrag event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ B4MouseDown()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4MouseDown ( Action< JFunction > action )

inlinevirtual

Code executed immediately before the onMouseDown event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ B4StartDrag()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.B4StartDrag ( Action< JFunction > action )

inlinevirtual

Code that executes immediately before the startDrag event

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ DefaultPadding()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.DefaultPadding ( Action< Paddings > action )

inlinevirtual

Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ EndDrag()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.EndDrag ( Action< JFunction > action )

inlinevirtual

Fired when we are done dragging the object

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ GetDragEl()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.GetDragEl ( Action< JFunction > action )

inlinevirtual

Returns a reference to the actual element to drag. By default this is the same as the html element, but it can be assigned to another element. An example of this can be found in Ext.dd.DDProxy

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ Group()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.Group ( string group )

inlinevirtual

The group of related DragDrop objects

◆ Groups()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.Groups ( Action< DragDropGroups > action )

inlinevirtual

The group defines a logical collection of DragDrop objects that are related. Instances only get events when interacting with other DragDrop object in the same group. This lets us define multiple groups using a single DragDrop subclass if we want.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ HasOuterHandles()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.HasOuterHandles ( bool hasOuterHandles )

inlinevirtual

By default, drags can only be initiated if the mousedown occurs in the region the linked element is. This is done in part to work around a bug in some browsers that mis-report the mousedown if the previous mouseup happened outside of the window. This property is set to true if outer handles are defined.

◆ IgnoreSelf()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.IgnoreSelf ( bool ignoreSelf )

inlinevirtual

Set to false to enable a DragDrop object to fire drag events while dragging over its own Element. Defaults to true - DragDrop objects do not by default fire drag events to themselves.

◆ InvalidHandleClasses()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.InvalidHandleClasses ( string[] invalidHandleClasses )

inlinevirtual

An Array of CSS class names for elements to be considered in valid as drag handles.

◆ InvalidHandleIds()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.InvalidHandleIds ( string[] invalidHandleIds )

inlinevirtual

An array who's items identify the IDs of elements to be considered invalid as drag handles

◆ InvalidHandleTypes()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.InvalidHandleTypes ( string[] invalidHandleTypes )

inlinevirtual

An array who's items identify HTML tags to be considered invalid as drag handles.

◆ IsTarget()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.IsTarget ( bool isTarget )

inlinevirtual

By default, all instances can be a drop target. This can be disabled by setting isTarget to false.

◆ MaintainOffset()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.MaintainOffset ( bool maintainOffset )

inlinevirtual

Maintain offsets when we resetconstraints. Set to true when you want the position of the element relative to its parent to stay the same when the page changes

◆ MoveOnly()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.MoveOnly ( bool moveOnly )

inlinevirtual

When set to true, other DD objects in cooperating DDGroups do not receive notification events when this DD object is dragged over them. Defaults to false.

◆ OnAvailable()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnAvailable ( Action< JFunction > action )

inlinevirtual

Override the onAvailable method to do what is needed after the initial position was determined.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnDrag()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnDrag ( Action< JFunction > action )

inlinevirtual

Abstract method called during the onMouseMove event while dragging an object.

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnDragDrop()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnDragDrop ( Action< JFunction > action )

inlinevirtual

Abstract method called when this item is dropped on another DragDrop obj

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnDragEnter()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnDragEnter ( Action< JFunction > action )

inlinevirtual

Abstract method called when this element fist begins hovering over another DragDrop obj

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnDragOut()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnDragOut ( Action< JFunction > action )

inlinevirtual

Abstract method called when we are no longer hovering over an element

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnDragOver()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnDragOver ( Action< JFunction > action )

inlinevirtual

Abstract method called when this element is hovering over another DragDrop obj

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnInvalidDrop()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnInvalidDrop ( Action< JFunction > action )

inlinevirtual

Abstract method called when this item is dropped on an area with no drop target

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnMouseDown()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnMouseDown ( Action< JFunction > action )

inlinevirtual

Event handler that fires when a drag/drop obj gets a mousedown

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ OnMouseUp()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.OnMouseUp ( Action< JFunction > action )

inlinevirtual

Event handler that fires when a drag/drop obj gets a mouseup

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ Padding()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.Padding ( int[] padding )

inlinevirtual

The padding configured for this drag and drop object for calculating the drop zone intersection with this object. An array containing the 4 padding values: [top, right, bottom, left]

◆ PrimaryButtonOnly()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.PrimaryButtonOnly ( bool primaryButtonOnly )

inlinevirtual

By default the drag and drop instance will only respond to the primary button click (left button for a right-handed mouse). Set to true to allow drag and drop to start with any mouse click that is propogated by the browser

◆ StartDrag()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.StartDrag ( Action< JFunction > action )

inlinevirtual

Event handler that fires when a drag/drop obj gets a mouseup

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ Target()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.Target ( string target )

inlinevirtual

The id of the element associated with this object. This is what we refer to as the "linked element" because the size and position of this element is used to determine when the drag and drop objects have interacted.

◆ XTicks()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.XTicks ( int[] xTicks )

inlinevirtual

Array of pixel locations the element will snap to if we specified a horizontal graduation/interval. This array is generated automatically when you define a tick interval.

◆ YTicks()

virtual TBuilder Ext.Net.DragDrop.Builder< TDragDrop, TBuilder >.YTicks ( int[] yTicks )

inlinevirtual

Array of pixel locations the element will snap to if we specified a vertical graduation/interval. This array is generated automatically when you define a tick interval.

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

DragDropBuilder.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ B4Drag()

◆ B4DragDrop()

◆ B4DragOut()

◆ B4DragOver()

◆ B4EndDrag()

◆ B4MouseDown()

◆ B4StartDrag()

◆ DefaultPadding()

◆ EndDrag()

◆ GetDragEl()

◆ Group()

◆ Groups()

◆ HasOuterHandles()

◆ IgnoreSelf()

◆ InvalidHandleClasses()

◆ InvalidHandleIds()

◆ InvalidHandleTypes()

◆ IsTarget()

◆ MaintainOffset()

◆ MoveOnly()

◆ OnAvailable()

◆ OnDrag()

◆ OnDragDrop()

◆ OnDragEnter()

◆ OnDragOut()

◆ OnDragOver()

◆ OnInvalidDrop()

◆ OnMouseDown()

◆ OnMouseUp()

◆ Padding()

◆ PrimaryButtonOnly()

◆ StartDrag()

◆ Target()

◆ XTicks()

◆ YTicks()