org.wicketstuff.jwicket.ui.dragdrop

Interface IDraggable

public interface IDraggable

This is a marker interface. You can mark any Wicket Component with this interface and implement the interface's methods. iF the corresponding DraggableBehavior has activated the callbacks for the events then the dragged Wicket Component's methods are called

Method Summary

Methods

Modifier and Type	Method and Description
void	onDrag(org.apache.wicket.ajax.AjaxRequestTarget target, SpecialKeys specialKeys) If the Wicket Component is marked as draggable by adding a DraggableBehavior to it and the DraggableBehavior has DraggableBehavior.setWantOnDragNotification(boolean) to true, this method is called every time the mouse is moved while draging this Component.
void	onDragStart(org.apache.wicket.ajax.AjaxRequestTarget target, SpecialKeys specialKeys) If the Wicket Component is marked as draggable by adding a DraggableBehavior to it and the DraggableBehavior has DraggableBehavior.setWantOnDragStartNotification(boolean) to true, this method is called when the user starts to drag this Component.
void	onDragStop(org.apache.wicket.ajax.AjaxRequestTarget target, SpecialKeys specialKeys) If the Wicket Component is marked as draggable by adding a DraggableBehavior to it and the DraggableBehavior has DraggableBehavior.setWantOnDragStopNotification(boolean) to true, this method is called when the user stops to drag this Component.

Method Detail

onDragStart

void onDragStart(org.apache.wicket.ajax.AjaxRequestTarget target,
               SpecialKeys specialKeys)

If the Wicket Component is marked as draggable by adding a DraggableBehavior to it and the DraggableBehavior has DraggableBehavior.setWantOnDragStartNotification(boolean) to true, this method is called when the user starts to drag this Component.

Parameters:

target - The AjaxRequestTarget associated with this drag operation.

specialKeys - the special keys that were pressed when the event occurs

onDrag

void onDrag(org.apache.wicket.ajax.AjaxRequestTarget target,
          SpecialKeys specialKeys)

If the Wicket Component is marked as draggable by adding a DraggableBehavior to it and the DraggableBehavior has DraggableBehavior.setWantOnDragNotification(boolean) to true, this method is called every time the mouse is moved while draging this Component. So be careful using this method!

Parameters:

target - The AjaxRequestTarget associated with this drag operation.

specialKeys - the special keys that were pressed when the event occurs

onDragStop

void onDragStop(org.apache.wicket.ajax.AjaxRequestTarget target,
              SpecialKeys specialKeys)

If the Wicket Component is marked as draggable by adding a DraggableBehavior to it and the DraggableBehavior has DraggableBehavior.setWantOnDragStopNotification(boolean) to true, this method is called when the user stops to drag this Component. The drag operation is stopped by releasing the mouse button and it is makes no difference if you stop the drag operation by dropping the Component onto a droppable or somewhere around the page. There is no guarantee that this method is called before the droppable Component's callback method onDrop is called.

Parameters:

target - The AjaxRequestTarget associated with this drag operation.

specialKeys - the special keys that were pressed when the event occurs