Drag and drop behavior

Name space	rialto.widgetBehavior
FILE	multi-files in rialtoEngine\javascript\core\coreBehaviors\DD_*.js
NAME	Drag and drop behavior
INHERITS
VERSION	0.86
update
DESCRIPTION	It is rather the description of the affectation of the drag and drop behavior (relative to several files) than the description of an independent component

Details of setup properties

Name	Type	Description	Default
oHtmlEvtTarget	object	object that will catch the mouse event
oHtmlToMove	object	HTML object to move. This parameter allow to attach drag and drop behavior to javascript object even if they doesn't directly refer to an html object
dragMood	string	direct move ('directMove ') or ghost of object to move('ghostMove')	directMove
bSelectMark	boolean	if true display selection during drag	true if use a ghost else false
Ghost.aspect	string	ghost aspect 'frame' (border dash),'rect' (plain div) or 'icon' (little square)	frame
Ghost.top	int	top of the ghost if it is not the same as the object	0
Ghost.height	int	height of the ghost if it is not the same as the object
bMUpAction	boolean	if true activate a callback function (synchroDDMup ) onmouse up	true
magneticsGrid.widthCol	int	width of the row of the magnetic grid
magneticsGrid.heightRow	int	height of the row of the magnetic grid
bRectLim	boolean	indicate that a limit object must be use	true
bDynamicsMovingLimits	boolean	if true the moving limits are evaluate on each drag and drop cycle else they are calculate only on the initial affectof the behavior	true
movingLimits.rectLim.orientation	sring	drag limitation: none ('2D'),only horizontal ('h') or vertical('v') drag	2D
movingLimits.rectLim.top	int	top of the limit rectangle
movingLimits.rectLim.left	int	left of the limit rectangle
movingLimits.rectLim.bottom	int	bottom of the limit rectangle
movingLimits.rectLim.right	int	right of the limit rectangle
movingLimits.rectLim.oHtmlRef	object	specify the html object to use to calculate the moving limits	html parent of the drag object
movingLimits.rectLim.bCircular	boolean	if set to true, arrived at the limit the object takes the position opposed in the limiting rectangle	false
isWithLimitsDisplayed	boolean	if true display limits border during drag	true
isWithMovingInfo	boolean	if true display moving informations during drag	true
sensitiveEdgeWidth	int	number of pixel from the border to exclude for the drag and drop. This propertie is use when an object must have drag and drop and resize behavior.	0
whichMouseButtonForDD	string	specify which mous button can start the drag behavior ('left','right' or 'both')	left

Example:

	  	    var o = document.getElementById('objectToMove');
			var setup ={bRectLim 	: false
			,ghost		: {aspect:	'rect'}
			,sensitiveEdgeWidth  :3
			,isWithMovingInfo : true};							
			rialto.widgetBehavior.affect(o,'DragAndDrop',setup);

CALLBACK METHODS

Method	Arguments list	Return value	Inherits	To redefine
synchro	object totalMove,object sinceLastMove	void	no	yes
synchroDDMup	object totalMove	void	no	yes
afterDD	int t_total,int l_total	void	no	yes
afterClic		void	no	yes

synchro

this method is raise on each mouse move event and she pass as parameter an object that contains move informations

Parameters:
object totalMove:object with 2 properties 'top' and 'left' that represents the total top and left move from the begining of the drag
object sinceLastMove:object with 2 properties 'top' and 'left' that represents the top and left move till last mouse move

The code must be redefine after the affectation of the behavior. By default this method does nothing.

synchroDDMup

this method is raise at the end of the drag ONLY IF THE OBJECT AS REALLY MOVE and she pass as parameter an object that contains move informations

Parameters:
object totalMove:object with 2 properties 'top' and 'left' that represents the total top and left move from the begining of the drag

The code must be redefine after the affectation of the behavior. By default this method does nothing.

afterClic

this method is raise at the end of the drag

Parameters:
int t_total:represents the total top move from the begining of the drag
int l_total:represents the total left move from the begining of the drag

The code must be redefine after the affectation of the behavior. By default this method does nothing.

afterClic

this method is raise when there is a click without movement. You have to redifine this method when you want to add a onclick event handler on the object that have a drag androp behavior.

Parameters:

The code must be redefine after the affectation of the behavior. By default this method does nothing.