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

Class SelectableBehavior<T extends Serializable>

java.lang.Object
org.apache.wicket.behavior.Behavior
com.googlecode.wicket.jquery.core.JQueryAbstractBehavior
com.googlecode.wicket.jquery.core.JQueryBehavior
com.googlecode.wicket.jquery.ui.JQueryUIBehavior
com.googlecode.wicket.jquery.ui.interaction.selectable.SelectableBehavior<T>
Type Parameters:
T - the object type
All Implemented Interfaces:
com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware, JQueryDestroyListener.IDestroyable, Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable
public abstract class SelectableBehavior<T extends Serializable> extends JQueryUIBehavior implements com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware
Provides a jQuery selectable behavior
Author:
Sebastien Briquet - sebfz1
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected class 
    SelectableBehavior.OnStopAjaxBehavior
    Provides a JQueryAjaxBehavior that aims to be wired to the 'stop' event
    protected static class 
    SelectableBehavior.StopEvent
    Provides an event object that will be broadcasted by the OnStopAjaxBehavior callback

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    METHOD
     

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

    method, options, selector

  • Constructor Summary

    Constructors
    Constructor
    Description
    SelectableBehavior(String selector, com.googlecode.wicket.jquery.core.Options options, ISelectableListener<T> listener)
    Constructor
    SelectableBehavior(String selector, ISelectableListener<T> listener)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bind(org.apache.wicket.Component component)
     
    protected abstract List<T>
    getItemList()
    Gets the reference list of all selectable items.
    protected abstract String
    getItemSelector()
    Gets the selector that identifies the selectable item within a selectable item list
    The selector should be the path from the selectable component to the item (for instance '#myUL LI', where '#myUL' is the selectable's selector)
    protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior
    newOnStopAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)
    Gets a new JQueryAjaxBehavior that will be wired to the 'stop' event, triggered when the user has selected items
    void
    onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, com.googlecode.wicket.jquery.core.JQueryEvent event)
     
    void
    onConfigure(org.apache.wicket.Component component)
     

    Methods inherited from class com.googlecode.wicket.jquery.ui.JQueryUIBehavior

    destroy, onDestroy, widget, widget, widget, widget

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

    $, $, $, $, beforeRender, detach, getMethod, getOption, getOptions, getSelector, off, on, on, register, remove, renderHead, setOption, setOption, setOption, setOptions, setSelector

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

    add, getJQueryLibrarySettings, renderOnDomReadyScript, renderPriorityHeaderItem, toString

    Methods inherited from class org.apache.wicket.behavior.Behavior

    afterRender, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onEvent, onException, onRemove, onTag, unbind

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • SelectableBehavior

      public SelectableBehavior(String selector, ISelectableListener<T> listener)
      Constructor
      Parameters:
      selector - the html selector (ie: "#myId")
      listener - the ISelectableListener

    • SelectableBehavior

      public SelectableBehavior(String selector, com.googlecode.wicket.jquery.core.Options options, ISelectableListener<T> listener)
      Constructor
      Parameters:
      selector - the html selector (ie: "#myId")
      options - the Options
      listener - the ISelectableListener

  • Method Details

    • getItemList

      protected abstract List<T> getItemList()
      Gets the reference list of all selectable items.
      Returns:
      the list of all selectable items.

    • getItemSelector

      protected abstract String getItemSelector()
      Gets the selector that identifies the selectable item within a selectable item list
      The selector should be the path from the selectable component to the item (for instance '#myUL LI', where '#myUL' is the selectable's selector)
      Returns:
      "li" by default

    • bind

      public void bind(org.apache.wicket.Component component)
      Overrides:
      bind in class org.apache.wicket.behavior.Behavior

    • onConfigure

      public void onConfigure(org.apache.wicket.Component component)
      Overrides:
      onConfigure in class JQueryUIBehavior

    • onAjax

      public void onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, com.googlecode.wicket.jquery.core.JQueryEvent event)
      Specified by:
      onAjax in interface com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

    • newOnStopAjaxBehavior

      protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newOnStopAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)
      Gets a new JQueryAjaxBehavior that will be wired to the 'stop' event, triggered when the user has selected items
      Parameters:
      source - the IJQueryAjaxAware
      Returns:
      a new OnStopAjaxBehavior by default