com.googlecode.wicket.jquery.ui.interaction.droppable

Class DroppableBehavior

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.droppable.DroppableBehavior

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 DroppableBehavior
extends JQueryUIBehavior
implements IJQueryAjaxAware

Provides a jQuery droppable behavior

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DroppableBehavior.DropEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'drop' callback
protected static class	DroppableBehavior.ExitEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'exit' callback
protected static class	DroppableBehavior.OverEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'over' callback

Field Summary

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

method, options, selector

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(org.apache.wicket.Component component)
boolean	isExitEventEnabled() Indicates whether the 'exit' (or 'out') event is enabled. If true, the onExit(AjaxRequestTarget, Component) event will be triggered.
boolean	isOverEventEnabled() Indicates whether the 'over' event is enabled. If true, the onOver(AjaxRequestTarget, Component) event will be triggered.
protected JQueryAjaxBehavior	newOnDropBehavior() Gets a new JQueryAjaxBehavior that will be called on 'drop' javascript event
protected JQueryAjaxBehavior	newOnExitBehavior() Gets a new JQueryAjaxBehavior that will be called on 'exit' javascript event
protected JQueryAjaxBehavior	newOnOverBehavior() Gets a new JQueryAjaxBehavior that will be called on 'over' javascript event
void	onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, JQueryEvent event)
void	onConfigure(org.apache.wicket.Component component)
void	onDrop(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component component) Triggered when a component with DraggableBehavior has been dropped
void	onExit(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component component) Triggered when a component with DraggableBehavior exits the droppable area
void	onOver(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component component) Triggered when a component with DraggableBehavior overs the droppable area
void	setDraggable(org.apache.wicket.Component draggable)

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

DroppableBehavior

public DroppableBehavior(java.lang.String selector)

Constructor

Parameters:

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

DroppableBehavior

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

Constructor

Parameters:

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

options - the Options

Method Detail

setDraggable

public void setDraggable(org.apache.wicket.Component draggable)

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

newOnDropBehavior

protected JQueryAjaxBehavior newOnDropBehavior()

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

Returns:

the JQueryAjaxBehavior

newOnOverBehavior

protected JQueryAjaxBehavior newOnOverBehavior()

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

Returns:

the JQueryAjaxBehavior

newOnExitBehavior

protected JQueryAjaxBehavior newOnExitBehavior()

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

Returns:

the JQueryAjaxBehavior

isOverEventEnabled

public boolean isOverEventEnabled()

Indicates whether the 'over' event is enabled.
If true, the onOver(AjaxRequestTarget, Component) event will be triggered.

Returns:

false by default

isExitEventEnabled

public boolean isExitEventEnabled()

Indicates whether the 'exit' (or 'out') event is enabled.
If true, the onExit(AjaxRequestTarget, Component) event will be triggered.

Returns:

false by default

onDrop

public void onDrop(org.apache.wicket.ajax.AjaxRequestTarget target,
          org.apache.wicket.Component component)

Triggered when a component with DraggableBehavior has been dropped

Parameters:

target - the AjaxRequestTarget

component - the component with DraggableBehavior

onOver

public void onOver(org.apache.wicket.ajax.AjaxRequestTarget target,
          org.apache.wicket.Component component)

Triggered when a component with DraggableBehavior overs the droppable area

Parameters:

target - the AjaxRequestTarget

component - the component with DraggableBehavior

See Also:

isOverEventEnabled()

onExit

public void onExit(org.apache.wicket.ajax.AjaxRequestTarget target,
          org.apache.wicket.Component component)

Triggered when a component with DraggableBehavior exits the droppable area

Parameters:

target - the AjaxRequestTarget

component - the component with DraggableBehavior

See Also:

isExitEventEnabled()