com.googlecode.wicket.jquery.ui.interaction.draggable

Class DraggableBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

com.googlecode.wicket.jquery.core.JQueryBehavior

com.googlecode.wicket.jquery.ui.JQueryUIBehavior

com.googlecode.wicket.jquery.ui.interaction.draggable.DraggableBehavior

All Implemented Interfaces:

IJQueryAjaxAware, java.io.Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public abstract class DraggableBehavior
extends JQueryUIBehavior
implements IJQueryAjaxAware

Provides a jQuery draggable behavior

Warning: not thread-safe: the instance of this behavior should only be used once

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DraggableBehavior.DraggableEvent Provides a base class for draggable event object
protected static class	DraggableBehavior.DragStartEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'start' callback
protected static class	DraggableBehavior.DragStopEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'stop' callback

Field Summary

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryBehavior

method, options, selector

Constructor Summary

Constructors

Constructor and Description
DraggableBehavior(java.lang.String selector) Constructor
DraggableBehavior(java.lang.String selector, Options options) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(org.apache.wicket.Component component)
boolean	isStopEventEnabled() Indicates whether the 'stop' event is enabled. If true, the onDragStop(AjaxRequestTarget, int, int) event will be triggered.
protected JQueryAjaxBehavior	newOnDragStartBehavior() Gets a new JQueryAjaxBehavior that will be called on 'start' javascript event
protected JQueryAjaxBehavior	newOnDragStopBehavior() Gets a new JQueryAjaxBehavior that will be called on 'stop' javascript event
void	onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, JQueryEvent event)
void	onConfigure(org.apache.wicket.Component component)
void	onDragStart(org.apache.wicket.ajax.AjaxRequestTarget target, int top, int left) Triggered when the drag starts Note: offsetTop and offsetLeft are available as RequestCycle parameters
void	onDragStop(org.apache.wicket.ajax.AjaxRequestTarget target, int top, int left) Triggered when the drag stops offsetTop and offsetLeft are available as RequestCycle parameters

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryBehavior

$, $, $, beforeRender, getMethod, getOption, getOptions, getSelector, on, on, on, renderHead, setOption, setOption, setOption, setOptions, setSelector

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

add, getJQueryLibrarySettings, getToken, renderScript, toString

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

afterRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

DraggableBehavior

public DraggableBehavior(java.lang.String selector)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

DraggableBehavior

public DraggableBehavior(java.lang.String selector,
                 Options options)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

options - the Options

Method Detail

bind

public void bind(org.apache.wicket.Component component)

Overrides:

bind in class org.apache.wicket.behavior.Behavior

onConfigure

public void onConfigure(org.apache.wicket.Component component)

Overrides:

onConfigure in class JQueryUIBehavior

onAjax

public void onAjax(org.apache.wicket.ajax.AjaxRequestTarget target,
          JQueryEvent event)

Specified by:

onAjax in interface IJQueryAjaxAware

newOnDragStartBehavior

protected JQueryAjaxBehavior newOnDragStartBehavior()

Gets a new JQueryAjaxBehavior that will be called on 'start' javascript event

Returns:

the JQueryAjaxBehavior

newOnDragStopBehavior

protected JQueryAjaxBehavior newOnDragStopBehavior()

Gets a new JQueryAjaxBehavior that will be called on 'stop' javascript event

Returns:

the JQueryAjaxBehavior

isStopEventEnabled

public boolean isStopEventEnabled()

Indicates whether the 'stop' event is enabled.
If true, the onDragStop(AjaxRequestTarget, int, int) event will be triggered.

Returns:

false by default

onDragStart

public void onDragStart(org.apache.wicket.ajax.AjaxRequestTarget target,
               int top,
               int left)

Triggered when the drag starts
Note: offsetTop and offsetLeft are available as RequestCycle parameters

Parameters:

target - the AjaxRequestTarget

top - the position's top value

left - the position's left value

onDragStop

public void onDragStop(org.apache.wicket.ajax.AjaxRequestTarget target,
              int top,
              int left)

Triggered when the drag stops
offsetTop and offsetLeft are available as RequestCycle parameters

Parameters:

target - the AjaxRequestTarget

top - the position's top value

left - the position's left value

See Also:

isStopEventEnabled()