com.googlecode.wicket.jquery.ui.interaction.selectable

Class Selectable<T extends java.io.Serializable>

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.selectable.Selectable<T>

Type Parameters:

T - the type of the model object

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 Selectable<T extends java.io.Serializable>
extends JQueryContainer

Provides a jQuery UI selectable JQueryContainer.
Children of that container can be selected using the mouse or by pressing ctrl+click
Usage:

 <ul wicket:id="selectable">
        <li wicket:id="items">
                <span wicket:id="item">[label]</span>
        </li>
 </ul>


 final Selectable<String> selectable = new Selectable<String>("selectable", list) {

        protected void onSelect(AjaxRequestTarget target)
        {
                //this.getModelObject(): gets the selected items
        }
 };

 this.add(selectable);
 

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

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
Selectable(java.lang.String id, org.apache.wicket.model.IModel<? extends java.util.List<T>> items) Constructor
Selectable(java.lang.String id, org.apache.wicket.model.IModel<? extends java.util.List<T>> model, org.apache.wicket.model.IModel<? extends java.util.List<T>> items) Constructor
Selectable(java.lang.String id, org.apache.wicket.model.IModel<? extends java.util.List<T>> model, java.util.List<T> items) Constructor
Selectable(java.lang.String id, java.util.List<T> items) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
Draggable<?>	createDraggable(java.lang.String id) Creates a Draggable object that is related to this Selectable. Uses a default factory that will create a Draggable with a ui-icon-arrow-4-diag icon
Draggable<?>	createDraggable(java.lang.String id, SelectableDraggableFactory factory) Creates a Draggable object that is related to this Selectable
protected java.util.List<T>	getItemList() Gets the reference list of all selectable items.
protected java.lang.String	getItemSelector() Gets the selector that identifies the selectable item within a Selectable The selector should be the path from the Selectable to the item (for instance '#myUL LI', where '#myUL' is the Selectable's selector)
org.apache.wicket.model.IModel<? extends java.util.List<T>>	getModel() Gets the model object
java.util.List<T>	getModelObject() Gets the model object
protected JQueryAbstractBehavior	newSelectedBehavior() Gets the JQueryAbstractBehavior in charge of selecting default items (matching model object)
JQueryBehavior	newWidgetBehavior(java.lang.String selector)
protected void	onConfigure()
protected void	onDetach()
void	onSelect(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered when a selection has been made (stops)
void	setModelObject(java.util.List<T> list) Sets the model object

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

Selectable

public Selectable(java.lang.String id,
          java.util.List<T> items)

Constructor

Parameters:

id - the markup id

items - the list the Selectable should observe.

Selectable

public Selectable(java.lang.String id,
          org.apache.wicket.model.IModel<? extends java.util.List<T>> items)

Constructor

Parameters:

id - the markup id

items - the list the Selectable should observe.

Selectable

public Selectable(java.lang.String id,
          org.apache.wicket.model.IModel<? extends java.util.List<T>> model,
          java.util.List<T> items)

Constructor

Parameters:

id - the markup id

model - the list of selected items

items - the list the Selectable should observe.

Selectable

public Selectable(java.lang.String id,
          org.apache.wicket.model.IModel<? extends java.util.List<T>> model,
          org.apache.wicket.model.IModel<? extends java.util.List<T>> items)

Constructor

Parameters:

id - the markup id

model - the list of selected items

items - the list the Selectable should observe.

Method Detail

getModel

public org.apache.wicket.model.IModel<? extends java.util.List<T>> getModel()

Gets the model object

Returns:

the list of selected items

getModelObject

public java.util.List<T> getModelObject()

Gets the model object

Returns:

the list of selected items

setModelObject

public void setModelObject(java.util.List<T> list)

Sets the model object

Parameters:

list - the list of selected items

getItemList

protected java.util.List<T> getItemList()

Gets the reference list of all selectable items.

Returns:

the list of all selectable items.

getItemSelector

protected java.lang.String getItemSelector()

Gets the selector that identifies the selectable item within a Selectable
The selector should be the path from the Selectable to the item (for instance '#myUL LI', where '#myUL' is the Selectable's selector)

Returns:

"li" by default

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class org.apache.wicket.Component

onSelect

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

Triggered when a selection has been made (stops)

Parameters:

target - the AjaxRequestTarget

onDetach

protected void onDetach()

Overrides:

onDetach in class org.apache.wicket.Component

newSelectedBehavior

protected JQueryAbstractBehavior newSelectedBehavior()

Gets the JQueryAbstractBehavior in charge of selecting default items (matching model object)

Returns:

the JQueryAbstractBehavior

newWidgetBehavior

public JQueryBehavior newWidgetBehavior(java.lang.String selector)

createDraggable

public Draggable<?> createDraggable(java.lang.String id)

Creates a Draggable object that is related to this Selectable.
Uses a default factory that will create a Draggable with a ui-icon-arrow-4-diag icon

Parameters:

id - the markup id

Returns:

the Draggable

createDraggable

public Draggable<?> createDraggable(java.lang.String id,
                           SelectableDraggableFactory factory)

Creates a Draggable object that is related to this Selectable

Parameters:

id - the markup id

factory - the SelectableDraggableFactory instance

Returns:

the Draggable