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

Class Draggable<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.googlecode.wicket.jquery.core.JQueryContainer

com.googlecode.wicket.jquery.ui.interaction.draggable.Draggable<T>

Type Parameters:

T - the object model type

All Implemented Interfaces:

IJQueryWidget, java.io.Serializable, java.lang.Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class Draggable<T>
extends JQueryContainer

Provides a jQuery draggable element based on a JQueryContainer

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Draggable.Axis
static class	Draggable.Containment

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

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

widgetBehavior

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
Draggable(java.lang.String id) Contructor
Draggable(java.lang.String id, org.apache.wicket.model.IModel<T> model) Contructor

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.wicket.model.IModel<T>	getModel() Gets the model
T	getModelObject() Gets the model object
boolean	isStopEventEnabled() Indicates whether the 'stop' event is enabled. If true, the onDragStop(AjaxRequestTarget, int, int) event will be triggered.
JQueryBehavior	newWidgetBehavior(java.lang.String selector)
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
Draggable<T>	setAxis(Draggable.Axis axis) Sets the Draggable.Axis on which it is possible to drag the component
Draggable<T>	setContainment(org.apache.wicket.Component component) Sets the container on which this component is allowed to move.
Draggable<T>	setContainment(Draggable.Containment containment) Sets the container, specified by a Draggable.Containment, on which this component is allowed to move.
Draggable<T>	setContainment(java.lang.String selector) Sets the container, specified by its selector, on which this component is allowed to move.
Draggable<T>	setGrid(java.util.List<java.lang.Integer> grid) Sets the grid on which snapping the component
Draggable<T>	setRevert(java.lang.Boolean revert) Set whether the component should revert to its original position

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

onBeforeRender, onConfigure, onInitialize

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Draggable

public Draggable(java.lang.String id)

Contructor

Parameters:

id - the markup id

Draggable

public Draggable(java.lang.String id,
         org.apache.wicket.model.IModel<T> model)

Contructor

Parameters:

id - the markup id

model - the IModel

Method Detail

getModel

public org.apache.wicket.model.IModel<T> getModel()

Gets the model

Returns:

IModel

getModelObject

public T getModelObject()

Gets the model object

Returns:

the model object

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

setAxis

public Draggable<T> setAxis(Draggable.Axis axis)

Sets the Draggable.Axis on which it is possible to drag the component

Parameters:

axis - the Draggable.Axis value

Returns:

the Draggable

setGrid

public Draggable<T> setGrid(java.util.List<java.lang.Integer> grid)

Sets the grid on which snapping the component

Parameters:

grid - a [x, y] List, assuming its toString() method returns [x, y] (like ArrayList)

Returns:

the Draggable

setContainment

public Draggable<T> setContainment(org.apache.wicket.Component component)

Sets the container on which this component is allowed to move.

Parameters:

component - a Component

Returns:

the Draggable

setContainment

public Draggable<T> setContainment(java.lang.String selector)

Sets the container, specified by its selector, on which this component is allowed to move.

Parameters:

selector - the container selector (ie: '#myId')

Returns:

the Draggable

setContainment

public Draggable<T> setContainment(Draggable.Containment containment)

Sets the container, specified by a Draggable.Containment, on which this component is allowed to move.

Parameters:

containment - the Draggable.Containment value

Returns:

the Draggable

setRevert

public Draggable<T> setRevert(java.lang.Boolean revert)

Set whether the component should revert to its original position

Parameters:

revert - yes/no

Returns:

the Draggable

newWidgetBehavior

public JQueryBehavior newWidgetBehavior(java.lang.String selector)

Specified by:

newWidgetBehavior in interface IJQueryWidget