org.wicketstuff.scriptaculous.dragdrop
Class DraggableTarget

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.wicketstuff.scriptaculous.dragdrop.DraggableTarget

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

public abstract class DraggableTarget
extends org.apache.wicket.markup.html.WebMarkupContainer

Target for drag/drop operations. user can drop a Draggable item onto this component to perform ajax operation.

NOTE: only one DraggableTarget component is allowed for a Page. This is a limitation of the scriptaculous framework. Scriptaculous freaks out in IE6/7 when updating the HTML DOM for a particular Droppable object. We're able to refresh the current Droppable, but all other Droppables on the page will be broken.

See Also:

http://wiki.script.aculo.us/scriptaculous/show/Droppables.add, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

DraggableTarget(java.lang.String id)

Method Summary

void	acceptAll(SortableListView container) configure the draggable target to accept any draggable item from the SortableListView The sortable container needs to override SortableListView.getDraggableClassName() in order for the draggable target to know what to accept.
void	accepts(org.apache.wicket.Component component, java.lang.String className) configure the draggable target to accept a component.
protected abstract void	onDrop(org.apache.wicket.Component component, org.apache.wicket.ajax.AjaxRequestTarget target) extension point for defining functionality when a component is dropped.
protected void	onRender(org.apache.wicket.markup.MarkupStream markupStream)
void	setHoverClass(java.lang.String className) set an additional CSS class for when an accepted Draggable is hovered over it.

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

DraggableTarget

public DraggableTarget(java.lang.String id)

Method Detail

onDrop

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

extension point for defining functionality when a component is dropped.

Parameters:

component - the component dropped on the target

target - response to stream back to the user

accepts

public void accepts(org.apache.wicket.Component component,
                    java.lang.String className)

configure the draggable target to accept a component. The component must have a DraggableBehavior attached to it.

Parameters:

component -

className - css class name to add to the component

acceptAll

public void acceptAll(SortableListView container)

configure the draggable target to accept any draggable item from the SortableListView The sortable container needs to override SortableListView.getDraggableClassName() in order for the draggable target to know what to accept.

Parameters:

container -

setHoverClass

public void setHoverClass(java.lang.String className)

set an additional CSS class for when an accepted Draggable is hovered over it. default is none

Parameters:

className -

onRender

protected void onRender(org.apache.wicket.markup.MarkupStream markupStream)

Overrides:

onRender in class org.apache.wicket.MarkupContainer