com.googlecode.wicket.kendo.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.core.JQueryGenericContainer<T>

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

Type Parameters:

T - the object model type

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryWidget, IDraggableListener, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, 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 com.googlecode.wicket.jquery.core.JQueryGenericContainer<T>
implements IDraggableListener

Provides a Kendo UI draggable element based on a JQueryGenericContainer

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Draggable.Axis

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

com.googlecode.wicket.jquery.core.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(String id) Constructor
Draggable(String id, org.apache.wicket.model.IModel<T> model) Constructor
Draggable(String id, org.apache.wicket.model.IModel<T> model, com.googlecode.wicket.jquery.core.Options options) Constructor
Draggable(String id, com.googlecode.wicket.jquery.core.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
protected Draggable<T>	getHint(String function) Provides a way for customization of the drag indicator
boolean	isCancelEventEnabled() Indicates whether the 'dragcancel' event is enabled. If true, the IDraggableListener.onDragCancel(AjaxRequestTarget, int, int) event will be triggered.
com.googlecode.wicket.jquery.core.JQueryBehavior	newWidgetBehavior(String selector)
void	onDragCancel(org.apache.wicket.ajax.AjaxRequestTarget target, int top, int left) Triggered when the drag cancels offsetTop and offsetLeft are available as RequestCycle parameters
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) Constrains the hint movement to either the horizontal (x) or vertical (y) axis.
Draggable<T>	setContainer(org.apache.wicket.Component component) If set, the hint movement is constrained to the container boundaries.
Draggable<T>	setContainer(String selector) If set, the hint movement is constrained to the container boundaries.
Draggable<T>	setDistance(Integer distance) Sets the required distance that the mouse should travel in order to initiate a drag.

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

getModel, getModelObject, setModel, setModelObject

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Draggable

public Draggable(String id)

Constructor

Parameters:

id - the markup id

Draggable

public Draggable(String id,
                 com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

options - the Options

Draggable

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

Constructor

Parameters:

id - the markup id

model - the IModel

Draggable

public Draggable(String id,
                 org.apache.wicket.model.IModel<T> model,
                 com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the IModel

options - the Options

Method Detail

isCancelEventEnabled

public boolean isCancelEventEnabled()

Description copied from interface: IDraggableListener

Indicates whether the 'dragcancel' event is enabled.
If true, the IDraggableListener.onDragCancel(AjaxRequestTarget, int, int) event will be triggered.

Specified by:

isCancelEventEnabled in interface IDraggableListener

Returns:

false by default

onDragStart

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

Description copied from interface: IDraggableListener

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

Specified by:

onDragStart in interface IDraggableListener

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)

Description copied from interface: IDraggableListener

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

Specified by:

onDragStop in interface IDraggableListener

Parameters:

target - the AjaxRequestTarget

top - the position's top value

left - the position's left value

onDragCancel

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

Description copied from interface: IDraggableListener

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

Specified by:

onDragCancel in interface IDraggableListener

Parameters:

target - the AjaxRequestTarget

top - the position's top value

left - the position's left value

See Also:

IDraggableListener.isCancelEventEnabled()

setAxis

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

Constrains the hint movement to either the horizontal (x) or vertical (y) axis.

Parameters:

axis - the Draggable.Axis value

Returns:

this, for chaining

getHint

protected Draggable<T> getHint(String function)

Provides a way for customization of the drag indicator

Parameters:

function - the javascript function

Returns:

this, for chaining

setDistance

public Draggable<T> setDistance(Integer distance)

Sets the required distance that the mouse should travel in order to initiate a drag.

Parameters:

distance - the distance

Returns:

this, for chaining

setContainer

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

If set, the hint movement is constrained to the container boundaries.

Parameters:

component - a Component

Returns:

this, for chaining

setContainer

public Draggable<T> setContainer(String selector)

If set, the hint movement is constrained to the container boundaries.

Parameters:

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

Returns:

this, for chaining

newWidgetBehavior

public com.googlecode.wicket.jquery.core.JQueryBehavior newWidgetBehavior(String selector)

Specified by:

newWidgetBehavior in interface com.googlecode.wicket.jquery.core.IJQueryWidget