org.wicketstuff.jwicket.ui.dragdrop

Class DroppableBehavior

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

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 DroppableBehavior
extends AbstractDragDropBehavior

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DroppableBehavior.DropTolerance

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	uiDroppableJs

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
DroppableBehavior()

Method Summary

Methods

Modifier and Type	Method and Description
void	disable(org.apache.wicket.ajax.AjaxRequestTarget target) Disable the dropping
void	enable(org.apache.wicket.ajax.AjaxRequestTarget target) Enable the dropping
protected org.apache.wicket.util.visit.IVisitor<org.apache.wicket.Component,org.apache.wicket.Component>	getComponentFindingVisitor(String markupId)
protected JQueryAjaxBehavior.JsBuilder	getJsBuilder()
protected void	onActivate(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component draggedComponent, SpecialKeys specialKeys) This method is called when a draggable Component is starting to drag and the dragging Component's name is accepted to be dropped onto this.
protected void	onDeactivate(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component draggedComponent, SpecialKeys specialKeys) This method is called when a draggable Component has stopped dragging and the dragging Component's name was accepted to be dropped onto this.
protected void	onDrop(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component draggedComponent, SpecialKeys specialKeys) This method is called when a draggable Component is dropped onto a Component marked with this behavior.
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response) Do not override this method unless you know exactly what you do.
protected void	respond(org.apache.wicket.ajax.AjaxRequestTarget target) handles the event processing during dragging.
DroppableBehavior	setActiveClass(org.apache.wicket.ajax.AjaxRequestTarget target, String activeClass)
DroppableBehavior	setActiveClass(String activeClass) Sets the 'activeClass' property for this draggable.
DroppableBehavior	setAddClasses(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DroppableBehavior	setAddClasses(boolean value) Sets the 'addClasses' property for this draggable.
DroppableBehavior	setDraggablesAcceptedByDroppable(DraggablesAcceptedByDroppable accepted) You can restrict the Components that can be dragged and dropped to a Component marked with this behavior.
DroppableBehavior	setGreedy(org.apache.wicket.ajax.AjaxRequestTarget target, boolean value)
DroppableBehavior	setGreedy(boolean value) Sets the 'greedy' property for this draggable.
DroppableBehavior	setHoverClass(org.apache.wicket.ajax.AjaxRequestTarget target, String hoverClass)
DroppableBehavior	setHoverClass(String hoverClass) Sets the 'hoverClass' property for this draggable.
DroppableBehavior	setScope(org.apache.wicket.ajax.AjaxRequestTarget target, DroppableBehavior.DropTolerance tolerance)
DroppableBehavior	setScope(org.apache.wicket.ajax.AjaxRequestTarget target, String scope)
DroppableBehavior	setScope(String scope) Sets the 'scope' property for this draggable.
DroppableBehavior	setTolerance(DroppableBehavior.DropTolerance tolerance) Sets the 'tolerance' property for this droppable.
DroppableBehavior	setWantOnActivatedNotification(boolean value) If set to true, the callback-Method onActivate(AjaxRequestTarget, Component, SpecialKeys) is called when the drag operation ends.
DroppableBehavior	setWantOnDeactivateNotification(boolean value) If set to true, the callback-Method onDeactivate(AjaxRequestTarget, Component, SpecialKeys) is called when the drag operation ends.

Methods inherited from class org.wicketstuff.jwicket.JQueryDurableAjaxBehavior

isAlreadyRendered, 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

uiDroppableJs

public static final JQueryResourceReference uiDroppableJs

Constructor Detail

DroppableBehavior

public DroppableBehavior()

Method Detail

setWantOnActivatedNotification

public DroppableBehavior setWantOnActivatedNotification(boolean value)

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

Parameters:

value - true or false.

Returns:

this object

setWantOnDeactivateNotification

public DroppableBehavior setWantOnDeactivateNotification(boolean value)

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

Parameters:

value - true or false.

Returns:

this object

setDraggablesAcceptedByDroppable

public DroppableBehavior setDraggablesAcceptedByDroppable(DraggablesAcceptedByDroppable accepted)

You can restrict the Components that can be dragged and dropped to a Component marked with this behavior. See DraggablesAcceptedByDroppable for more information. If the DraggablesAcceptedByDroppable is empty (i.e. it contains no names) then the droppable does not accept any draggables.

Parameters:

accepted - the accepted

Returns:

this object

setActiveClass

public DroppableBehavior setActiveClass(String activeClass)

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

Parameters:

activeClass - the CSS class' name

Returns:

this object

setActiveClass

public DroppableBehavior setActiveClass(org.apache.wicket.ajax.AjaxRequestTarget target,
                               String activeClass)

setAddClasses

public DroppableBehavior 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 DroppableBehavior setAddClasses(org.apache.wicket.ajax.AjaxRequestTarget target,
                              boolean value)

setGreedy

public DroppableBehavior setGreedy(boolean value)

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

Parameters:

value - true or false.

Returns:

this object

setGreedy

public DroppableBehavior setGreedy(org.apache.wicket.ajax.AjaxRequestTarget target,
                          boolean value)

setHoverClass

public DroppableBehavior setHoverClass(String hoverClass)

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

Parameters:

hoverClass - the CSS class' name

Returns:

this object

setHoverClass

public DroppableBehavior setHoverClass(org.apache.wicket.ajax.AjaxRequestTarget target,
                              String hoverClass)

setScope

public DroppableBehavior setScope(String scope)

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

Parameters:

scope - the scode

Returns:

this object

setScope

public DroppableBehavior setScope(org.apache.wicket.ajax.AjaxRequestTarget target,
                         String scope)

setTolerance

public DroppableBehavior setTolerance(DroppableBehavior.DropTolerance tolerance)

Sets the 'tolerance' property for this droppable. Please consult the jquery documentation for a detailled description of this property.

Parameters:

tolerance - the tolerance

Returns:

this object

setScope

public DroppableBehavior setScope(org.apache.wicket.ajax.AjaxRequestTarget target,
                         DroppableBehavior.DropTolerance tolerance)

respond

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

handles the event processing during dragging.

Overrides:

respond in class JQueryAjaxBehavior

getComponentFindingVisitor

protected org.apache.wicket.util.visit.IVisitor<org.apache.wicket.Component,org.apache.wicket.Component> getComponentFindingVisitor(String markupId)

onDrop

protected void onDrop(org.apache.wicket.ajax.AjaxRequestTarget target,
          org.apache.wicket.Component draggedComponent,
          SpecialKeys specialKeys)

This method is called when a draggable Component is dropped onto a Component marked with this behavior.

Parameters:

target - the AjaxRequestTarget of the drop operation.

draggedComponent - The dragged component

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

onActivate

protected void onActivate(org.apache.wicket.ajax.AjaxRequestTarget target,
              org.apache.wicket.Component draggedComponent,
              SpecialKeys specialKeys)

This method is called when a draggable Component is starting to drag and the dragging Component's name is accepted to be dropped onto this.

Parameters:

target - The AjaxRequestTarget associated with this drop operation.

draggedComponent - The dragged component

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

onDeactivate

protected void onDeactivate(org.apache.wicket.ajax.AjaxRequestTarget target,
                org.apache.wicket.Component draggedComponent,
                SpecialKeys specialKeys)

This method is called when a draggable Component has stopped dragging and the dragging Component's name was accepted to be dropped onto this.

Parameters:

target - The AjaxRequestTarget associated with this drop operation.

draggedComponent - The dragged component

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

disable

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

Disable the dropping

Parameters:

target - An AjaxRequestTarget

enable

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

Enable the dropping

Parameters:

target - An AjaxRequestTarget

renderHead

public void renderHead(org.apache.wicket.Component component,
              org.apache.wicket.markup.head.IHeaderResponse response)

Description copied from class: JQueryDurableAjaxBehavior

Do not override this method unless you know exactly what you do. It is an internal method that handles the rendering of the JavaScript stuff for the behavior.

If you need to override this method, you must call super.renderHead(response).

Specified by:

renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor

Overrides:

renderHead in class JQueryDurableAjaxBehavior

getJsBuilder

protected JQueryAjaxBehavior.JsBuilder getJsBuilder()

Specified by:

getJsBuilder in class JQueryDurableAjaxBehavior