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.jquery.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.feedback.IFeedbackContributor
,org.apache.wicket.IConverterLocator
,org.apache.wicket.IGenericComponent<T,com.googlecode.wicket.jquery.core.JQueryGenericContainer<T>>
,org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>
,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 jQuery draggable element based on aJQueryGenericContainer
- Author:
- Sebastien Briquet - sebfz1
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Draggable.Axis
static class
Draggable.Containment
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isStopEventEnabled()
Indicates whether the 'stop' event is enabled.
If true, theIDraggableListener.onDragStop(AjaxRequestTarget, int, int)
event will be triggered.com.googlecode.wicket.jquery.core.JQueryBehavior
newWidgetBehavior(String selector)
void
onDragStart(org.apache.wicket.ajax.AjaxRequestTarget target, int top, int left)
Triggered when the drag starts
Note:offsetTop
andoffsetLeft
are available asRequestCycle
parametersvoid
onDragStop(org.apache.wicket.ajax.AjaxRequestTarget target, int top, int left)
Triggered when the drag stops
offsetTop and offsetLeft are available asRequestCycle
parametersDraggable<T>
setAxis(Draggable.Axis axis)
Sets theDraggable.Axis
on which it is possible to drag the componentDraggable<T>
setContainment(Draggable.Containment containment)
Sets the container, specified by aDraggable.Containment
, on which this component is allowed to move.Draggable<T>
setContainment(String selector)
Sets the container, specified by its selector, on which this component is allowed to move.Draggable<T>
setContainment(org.apache.wicket.Component component)
Sets the container on which this component is allowed to move.Draggable<T>
setGrid(List<Integer> grid)
Sets the grid on which snapping the componentDraggable<T>
setRevert(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
getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession
-
Methods inherited from class org.apache.wicket.MarkupContainer
add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren
-
Methods inherited from class org.apache.wicket.Component
add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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 org.apache.wicket.IGenericComponent
getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
isStopEventEnabled
public boolean isStopEventEnabled()
Description copied from interface:IDraggableListener
Indicates whether the 'stop' event is enabled.
If true, theIDraggableListener.onDragStop(AjaxRequestTarget, int, int)
event will be triggered.- Specified by:
isStopEventEnabled
in interfaceIDraggableListener
- 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
andoffsetLeft
are available asRequestCycle
parameters- Specified by:
onDragStart
in interfaceIDraggableListener
- Parameters:
target
- theAjaxRequestTarget
top
- the position's top valueleft
- 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 asRequestCycle
parameters- Specified by:
onDragStop
in interfaceIDraggableListener
- Parameters:
target
- theAjaxRequestTarget
top
- the position's top valueleft
- the position's left value- See Also:
IDraggableListener.isStopEventEnabled()
-
setAxis
public Draggable<T> setAxis(Draggable.Axis axis)
Sets theDraggable.Axis
on which it is possible to drag the component- Parameters:
axis
- theDraggable.Axis
value- Returns:
- the
Draggable
-
setGrid
public Draggable<T> setGrid(List<Integer> grid)
Sets the grid on which snapping the component
-
setContainment
public Draggable<T> setContainment(Draggable.Containment containment)
Sets the container, specified by aDraggable.Containment
, on which this component is allowed to move.- Parameters:
containment
- theDraggable.Containment
value- 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
- aComponent
- Returns:
- the
Draggable
-
setContainment
public Draggable<T> setContainment(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
-
setRevert
public Draggable<T> setRevert(Boolean revert)
Set whether the component should revert to its original position- Parameters:
revert
- yes/no- Returns:
- the
Draggable
-
newWidgetBehavior
public com.googlecode.wicket.jquery.core.JQueryBehavior newWidgetBehavior(String selector)
- Specified by:
newWidgetBehavior
in interfacecom.googlecode.wicket.jquery.core.IJQueryWidget
-
-