org.wicketstuff.jwicket.ui.dragdrop

Class DraggableBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.wicketstuff.jwicket.JQueryAjaxBehavior

org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

org.wicketstuff.jwicket.ui.AbstractJqueryUiEmbeddedBehavior

org.wicketstuff.jwicket.ui.dragdrop.AbstractDragDropBehavior

org.wicketstuff.jwicket.ui.dragdrop.DraggableBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public class DraggableBehavior
extends AbstractDragDropBehavior

You can add an instance of this class to a Wicket Component to make it draggable. An instance of this class can be added to one and only one Component. Another Component that should have exactly the same draggable behavior needs it's own instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DraggableBehavior.DragHelperMode
static class	DraggableBehavior.DragRevertMode
static class	DraggableBehavior.DragSnapMode

Nested classes/interfaces inherited from class org.wicketstuff.jwicket.ui.dragdrop.AbstractDragDropBehavior

AbstractDragDropBehavior.EventType

Nested classes/interfaces inherited from class org.wicketstuff.jwicket.JQueryAjaxBehavior

JQueryAjaxBehavior.JsAjaxCallbackFunction, JQueryAjaxBehavior.JsBuilder, JQueryAjaxBehavior.JsFunction

Field Summary

Fields

Modifier and Type	Field and Description
static JQueryResourceReference	jQueryUiDraggableJs

Fields inherited from class org.wicketstuff.jwicket.ui.AbstractJqueryUiEmbeddedBehavior

jQueryUiAccordionCss, jQueryUiBaseCss, jQueryUiCoreJs, jQueryUiCss, jQueryUiCustomCss, jQueryUiMouseJs, jQueryUiPositionJs, jQueryUiThemeCss, jQueryUiWidgetJs

Fields inherited from class org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

rendered

Fields inherited from class org.wicketstuff.jwicket.JQueryAjaxBehavior

rawOptions

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
DraggableBehavior()

Method Summary

Methods

Modifier and Type	Method and Description
void	disable(org.apache.wicket.ajax.AjaxRequestTarget target) Disable the dragging
void	enable(org.apache.wicket.ajax.AjaxRequestTarget target) Enable the dragging
protected JQueryAjaxBehavior.JsBuilder	getJsBuilder()
String	getName() Get the name of this draggable
protected void	onDrag(org.apache.wicket.ajax.AjaxRequestTarget target, SpecialKeys specialKeys) If you have set setWantOnDragNotification(boolean) to true this method is called whenever ths mouse moves during the drag operation.
protected void	onDragStart(org.apache.wicket.ajax.AjaxRequestTarget target, SpecialKeys specialKeys) If you have set setWantOnDragStartNotification(boolean) to true this method is called when the drag operation starts.
protected void	onDragStop(org.apache.wicket.ajax.AjaxRequestTarget target, SpecialKeys specialKeys) If you have set setWantOnDragStopNotification(boolean) to true this method is called when the drag operation stops.
protected void	respond(org.apache.wicket.ajax.AjaxRequestTarget target) handles the event processing during dragging.
DraggableBehavior	setAddClasses(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DraggableBehavior	setAddClasses(boolean value) Sets the 'addClasses' property for this draggable.
DraggableBehavior	setAxis(org.apache.wicket.ajax.AjaxRequestTarget target, char value)
DraggableBehavior	setAxis(char value) Sets the 'axis' property for this draggable.
DraggableBehavior	setCursor(org.apache.wicket.ajax.AjaxRequestTarget target, CssCursor value)
DraggableBehavior	setCursor(CssCursor value) Sets the 'cursor' property for this draggable.
DraggableBehavior	setCursorAt(org.apache.wicket.ajax.AjaxRequestTarget target, CssPosition position, int offset)
DraggableBehavior	setCursorAt(org.apache.wicket.ajax.AjaxRequestTarget target, CssPosition position1, int offset1, CssPosition position2, int offset2)
DraggableBehavior	setCursorAt(CssPosition position, int offset) Sets the 'cursorAt' property for this draggable.
DraggableBehavior	setCursorAt(CssPosition position1, int offset1, CssPosition position2, int offset2) Sets the 'cursorAt' property for this draggable.
DraggableBehavior	setDelay(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setDelay(int value) Sets the 'delay' property for this draggable.
DraggableBehavior	setDistance(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setDistance(org.apache.wicket.ajax.AjaxRequestTarget target, String value)
DraggableBehavior	setDistance(int value) Sets the 'distance' property for this draggable.
DraggableBehavior	setDistance(String value) Sets the 'helper' property for this draggable.
DraggableBehavior	setGrid(org.apache.wicket.ajax.AjaxRequestTarget target, int x, int y)
DraggableBehavior	setGrid(int x, int y) Sets the 'grid' property for this draggable.
DraggableBehavior	setHelper(org.apache.wicket.ajax.AjaxRequestTarget target, DraggableBehavior.DragHelperMode value)
DraggableBehavior	setHelper(org.apache.wicket.ajax.AjaxRequestTarget target, String function)
DraggableBehavior	setHelper(DraggableBehavior.DragHelperMode value) Sets the 'helper' property for this draggable to either "original" or "clone".
DraggableBehavior	setHelper(String function) Sets the 'helper' property for this draggable with a function.
DraggableBehavior	setIframeFix(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DraggableBehavior	setIframeFix(boolean value) Sets the 'iframeFix' property for this draggable.
DraggableBehavior	setName(String value) Sets the name of this draggable.
DraggableBehavior	setOpacity(org.apache.wicket.ajax.AjaxRequestTarget target, double value)
DraggableBehavior	setOpacity(double value) Sets the 'opacity' property for this draggable.
DraggableBehavior	setRefreshPositions(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DraggableBehavior	setRefreshPositions(boolean value) Sets the 'refreshPositions' property for this draggable.
DraggableBehavior	setRevert(org.apache.wicket.ajax.AjaxRequestTarget target, DraggableBehavior.DragRevertMode value)
DraggableBehavior	setRevert(DraggableBehavior.DragRevertMode value) Sets the 'revert' property for this draggable.
DraggableBehavior	setRevertDuration(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setRevertDuration(int value) Sets the 'revertDuration' property for this draggable.
DraggableBehavior	setScroll(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DraggableBehavior	setScroll(boolean value) Sets the 'scroll' property for this draggable.
DraggableBehavior	setScrollSensitivity(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setScrollSensitivity(int value) Sets the 'scrollSensitivity' property for this draggable.
DraggableBehavior	setScrollSpeed(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setScrollSpeed(int value) Sets the 'scrollSpeed' property for this draggable.
DraggableBehavior	setSnap(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DraggableBehavior	setSnap(boolean value) Sets the 'snap' property for this draggable.
DraggableBehavior	setSnapMode(org.apache.wicket.ajax.AjaxRequestTarget target, DraggableBehavior.DragSnapMode value)
DraggableBehavior	setSnapMode(DraggableBehavior.DragSnapMode value) Sets the 'snapMode' property for this draggable.
DraggableBehavior	setSnapTolerance(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setSnapTolerance(int value) Sets the 'snapTolerance' property for this draggable.
DraggableBehavior	setWantOnDragNotification(boolean value) If set to true, the callback-Method onDrag(AjaxRequestTarget, SpecialKeys) is called every time the mouse moves during the drag operation.
DraggableBehavior	setWantOnDragStartNotification(boolean value) If set to true, the callback-Method onDragStart(AjaxRequestTarget, SpecialKeys) is called when the drag operation starts.
DraggableBehavior	setWantOnDragStopNotification(boolean value) If set to true, the callback-Method onDragStop(AjaxRequestTarget, SpecialKeys) is called when the drag operation ends.
DraggableBehavior	setZIndex(org.apache.wicket.ajax.AjaxRequestTarget target, int value)
DraggableBehavior	setZIndex(long value) Sets the 'zIndex' property for this draggable.

Methods inherited from class org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

isAlreadyRendered, renderHead, setRestoreAfterRedraw, updateBehavior

Methods inherited from class org.wicketstuff.jwicket.JQueryAjaxBehavior

addCssResources, addUserProvidedResourceReferences, addUserProvidedResourceReferences, getUserProvidedResourceReferences, printParameters, printParameters, setRawOptions

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, onBind, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes, updateAjaxAttributes

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind

Methods inherited from class org.apache.wicket.behavior.Behavior

beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException, onRemove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jQueryUiDraggableJs

public static final JQueryResourceReference jQueryUiDraggableJs

Constructor Detail

DraggableBehavior

public DraggableBehavior()

Method Detail

respond

protected void respond(org.apache.wicket.ajax.AjaxRequestTarget target)

handles the event processing during dragging.

Overrides:

respond in class JQueryAjaxBehavior

setName

public DraggableBehavior setName(String value)

Sets the name of this draggable. The name can be used by a droppable componen to distinguish between allowed and forbidden droppables.

Parameters:

value - the name

Returns:

this object

getName

public String getName()

Get the name of this draggable

Returns:

The draggable's name

setAddClasses

public DraggableBehavior setAddClasses(boolean value)

Sets the 'addClasses' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - true or false.

Returns:

this object

setAddClasses

public DraggableBehavior setAddClasses(org.apache.wicket.ajax.AjaxRequestTarget target,
                              boolean value)

setAxis

public DraggableBehavior setAxis(char value)

Sets the 'axis' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - 'x' or 'y'.

Returns:

this object

setAxis

public DraggableBehavior setAxis(org.apache.wicket.ajax.AjaxRequestTarget target,
                        char value)

setCursor

public DraggableBehavior setCursor(CssCursor value)

Sets the 'cursor' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - a CssCursor

Returns:

this object

setCursor

public DraggableBehavior setCursor(org.apache.wicket.ajax.AjaxRequestTarget target,
                          CssCursor value)

setCursorAt

public DraggableBehavior setCursorAt(CssPosition position,
                            int offset)

Sets the 'cursorAt' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

position - a CssPosition

Returns:

this object

setCursorAt

public DraggableBehavior setCursorAt(org.apache.wicket.ajax.AjaxRequestTarget target,
                            CssPosition position,
                            int offset)

setCursorAt

public DraggableBehavior setCursorAt(CssPosition position1,
                            int offset1,
                            CssPosition position2,
                            int offset2)

Sets the 'cursorAt' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

position1 - a CssPosition

offset1 - the offset from position1

position2 - a CssPosition

offset2 - the offset from position2

Returns:

this object

setCursorAt

public DraggableBehavior setCursorAt(org.apache.wicket.ajax.AjaxRequestTarget target,
                            CssPosition position1,
                            int offset1,
                            CssPosition position2,
                            int offset2)

setDelay

public DraggableBehavior setDelay(int value)

Sets the 'delay' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the delay in ms

Returns:

this object

setDelay

public DraggableBehavior setDelay(org.apache.wicket.ajax.AjaxRequestTarget target,
                         int value)

setDistance

public DraggableBehavior setDistance(int value)

Sets the 'distance' property for this draggable. Please consult the jquery documentation for a detailled description of this property.

Parameters:

value - the value of this property.

Returns:

this object

setDistance

public DraggableBehavior setDistance(org.apache.wicket.ajax.AjaxRequestTarget target,
                            int value)

setGrid

public DraggableBehavior setGrid(int x,
                        int y)

Sets the 'grid' property for this draggable. Please consult the jquery documentation for a detailled description of this property.

Parameters:

x - the stepping along the x axis

y - the stepping along the y axis

Returns:

this object

setGrid

public DraggableBehavior setGrid(org.apache.wicket.ajax.AjaxRequestTarget target,
                        int x,
                        int y)

setDistance

public DraggableBehavior setDistance(String value)

Sets the 'helper' property for this draggable. Please consult the jquery documentation for a detailled description of this property.

Parameters:

value - original or clone

Returns:

this object

setDistance

public DraggableBehavior setDistance(org.apache.wicket.ajax.AjaxRequestTarget target,
                            String value)

setIframeFix

public DraggableBehavior setIframeFix(boolean value)

Sets the 'iframeFix' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - true or false.

Returns:

this object

setIframeFix

public DraggableBehavior setIframeFix(org.apache.wicket.ajax.AjaxRequestTarget target,
                             boolean value)

setOpacity

public DraggableBehavior setOpacity(double value)

Sets the 'opacity' property for this draggable. Please consult the jquery documentation for a detailled description of this property.

Parameters:

value - the opacity between 0 (transparent) and 1 (not transparent).

Returns:

this object

setOpacity

public DraggableBehavior setOpacity(org.apache.wicket.ajax.AjaxRequestTarget target,
                           double value)

setRefreshPositions

public DraggableBehavior setRefreshPositions(boolean value)

Sets the 'refreshPositions' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - true or false.

Returns:

this object

setRefreshPositions

public DraggableBehavior setRefreshPositions(org.apache.wicket.ajax.AjaxRequestTarget target,
                                    boolean value)

setRevert

public DraggableBehavior setRevert(DraggableBehavior.DragRevertMode value)

Sets the 'revert' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the revert behavior

Returns:

this object

setRevert

public DraggableBehavior setRevert(org.apache.wicket.ajax.AjaxRequestTarget target,
                          DraggableBehavior.DragRevertMode value)

setRevertDuration

public DraggableBehavior setRevertDuration(int value)

Sets the 'revertDuration' property for this draggable. Please consult the jquery documentation for a detailled description of this property.

Parameters:

value - the duration of the revert animation

Returns:

this object

setRevertDuration

public DraggableBehavior setRevertDuration(org.apache.wicket.ajax.AjaxRequestTarget target,
                                  int value)

setScroll

public DraggableBehavior setScroll(boolean value)

Sets the 'scroll' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - true or false.

Returns:

this object

setScroll

public DraggableBehavior setScroll(org.apache.wicket.ajax.AjaxRequestTarget target,
                          boolean value)

setScrollSensitivity

public DraggableBehavior setScrollSensitivity(int value)

Sets the 'scrollSensitivity' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the scroll sensitivity in px

Returns:

this object

setScrollSensitivity

public DraggableBehavior setScrollSensitivity(org.apache.wicket.ajax.AjaxRequestTarget target,
                                     int value)

setScrollSpeed

public DraggableBehavior setScrollSpeed(int value)

Sets the 'scrollSpeed' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the scroll speed in px

Returns:

this object

setScrollSpeed

public DraggableBehavior setScrollSpeed(org.apache.wicket.ajax.AjaxRequestTarget target,
                               int value)

setSnap

public DraggableBehavior setSnap(boolean value)

Sets the 'snap' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - true or false.

Returns:

this object

setSnap

public DraggableBehavior setSnap(org.apache.wicket.ajax.AjaxRequestTarget target,
                        boolean value)

setHelper

public DraggableBehavior setHelper(String function)

Sets the 'helper' property for this draggable with a function. Please consult the jQuery documentation for a detailed description of this property. DraggableHelper can be used for values of "original" and "clone", or a custom function can be used.

Parameters:

function -

Returns:

this object

setHelper

public DraggableBehavior setHelper(org.apache.wicket.ajax.AjaxRequestTarget target,
                          String function)

setHelper

public DraggableBehavior setHelper(DraggableBehavior.DragHelperMode value)

Sets the 'helper' property for this draggable to either "original" or "clone". Please consult the jQuery documentation for a detailed description of this property.

Parameters:

value -

Returns:

this object

setHelper

public DraggableBehavior setHelper(org.apache.wicket.ajax.AjaxRequestTarget target,
                          DraggableBehavior.DragHelperMode value)

setSnapMode

public DraggableBehavior setSnapMode(DraggableBehavior.DragSnapMode value)

Sets the 'snapMode' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the revert behavior

Returns:

this object

setSnapMode

public DraggableBehavior setSnapMode(org.apache.wicket.ajax.AjaxRequestTarget target,
                            DraggableBehavior.DragSnapMode value)

setSnapTolerance

public DraggableBehavior setSnapTolerance(int value)

Sets the 'snapTolerance' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the scroll speed in px

Returns:

this object

setSnapTolerance

public DraggableBehavior setSnapTolerance(org.apache.wicket.ajax.AjaxRequestTarget target,
                                 int value)

setZIndex

public DraggableBehavior setZIndex(long value)

Sets the 'zIndex' property for this draggable. Please consult the jQuery documentation for a detailled description of this property.

Parameters:

value - the scroll speed in px

Returns:

this object

setZIndex

public DraggableBehavior setZIndex(org.apache.wicket.ajax.AjaxRequestTarget target,
                          int value)

setWantOnDragStopNotification

public DraggableBehavior setWantOnDragStopNotification(boolean value)

If set to true, the callback-Method onDragStop(AjaxRequestTarget, SpecialKeys) is called when the drag operation ends.

Be careful when using this in conjunction with DroppableBehavior.onDrop(AjaxRequestTarget, Component, SpecialKeys). The Ajax calls issued by jQuery are processed asynchronous. So it my happen that the onDrop event reaches Wicket before the onDragStop event. This will cause an Exception in Wicket's internal processing if you replaced the dragged component with a new one in your onDrop handler becaus the dragged component no longer exists in wickets store when the onDragStop event is processed by Wicket.

Parameters:

value - true or false.

Returns:

this object

setWantOnDragNotification

public DraggableBehavior setWantOnDragNotification(boolean value)

If set to true, the callback-Method onDrag(AjaxRequestTarget, SpecialKeys) is called every time the mouse moves during the drag operation. Be careful using this callback because it can generate a lot of Ajax calls.

See {@link #setWantOnDragStartNotification(boolean) for a serious warning!

Parameters:

value - true or false.

Returns:

this object

setWantOnDragStartNotification

public DraggableBehavior setWantOnDragStartNotification(boolean value)

If set to true, the callback-Method onDragStart(AjaxRequestTarget, SpecialKeys) is called when the drag operation starts.

Parameters:

value - true or false.

Returns:

this object

onDragStart

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

If you have set setWantOnDragStartNotification(boolean) to true this method is called when the drag operation starts. You can override this method to perform some action when dragging starts.

Parameters:

target - the AjaxRequestTarget of the drag operation.

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

onDrag

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

If you have set setWantOnDragNotification(boolean) to true this method is called whenever ths mouse moves during the drag operation. You can override this method to perform some action during the drag operation.

Parameters:

target - the AjaxRequestTarget of the drag operation.

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

onDragStop

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

If you have set setWantOnDragStopNotification(boolean) to true this method is called when the drag operation stops. You can override this method to perform some action when dragging stops.

Parameters:

target - the AjaxRequestTarget of the drag operation.

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

disable

public void disable(org.apache.wicket.ajax.AjaxRequestTarget target)

Disable the dragging

Parameters:

target - An AjaxRequestTarget

enable

public void enable(org.apache.wicket.ajax.AjaxRequestTarget target)

Enable the dragging

Parameters:

target - An AjaxRequestTarget

getJsBuilder

protected JQueryAjaxBehavior.JsBuilder getJsBuilder()

Specified by:

getJsBuilder in class JQueryDurableAjaxBehavior