Package com.googlecode.wicket.jquery.ui.form.spinner

Class AjaxSpinner<T extends Number>

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
org.apache.wicket.markup.html.form.FormComponent<T>
org.apache.wicket.markup.html.form.AbstractTextComponent<T>
org.apache.wicket.markup.html.form.TextField<T>
com.googlecode.wicket.jquery.ui.form.spinner.Spinner<T>
com.googlecode.wicket.jquery.ui.form.spinner.AjaxSpinner<T>
Type Parameters:
T - the type of the model object
All Implemented Interfaces:
com.googlecode.wicket.jquery.core.IJQueryCultureWidget, com.googlecode.wicket.jquery.core.IJQueryWidget, ISpinnerListener, 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,org.apache.wicket.markup.html.form.FormComponent<T>>, org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>, 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 AjaxSpinner<T extends Number> extends Spinner<T> implements ISpinnerListener
Provides an ajax jQuery spinner based on a TextField
The type ctor arg is mandatory due to the convertValue(String) method
Since:
1.5.0
Author:
Sebastien Briquet - sebfz1
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

    org.apache.wicket.markup.html.form.AbstractTextComponent.ITextFormatProvider

    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.ui.form.spinner.Spinner

    options

    Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

    FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

    Fields inherited from class org.apache.wicket.Component

    ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

  • Constructor Summary

    Constructors
    Constructor
    Description
    AjaxSpinner(String id, com.googlecode.wicket.jquery.core.Options options, Class<T> type)
    Constructor
    AjaxSpinner(String id, Class<T> type)
    Constructor
    AjaxSpinner(String id, org.apache.wicket.model.IModel<T> model, com.googlecode.wicket.jquery.core.Options options, Class<T> type)
    Constructor
    AjaxSpinner(String id, org.apache.wicket.model.IModel<T> model, Class<T> type)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    convertValue(String value)
    Converts the supplied value using the type converter
    boolean
    isOnSpinEventEnabled()
    Indicates whether the 'spin' event is enabled.
    If true, the ISpinnerListener.onSpin(AjaxRequestTarget, String) event will be triggered
    boolean
    isOnStopEventEnabled()
    Indicates whether the 'stop' event is enabled.
    If true, the ISpinnerListener.onStop(AjaxRequestTarget) event will be triggered
    JQueryUIBehavior
    newWidgetBehavior(String selector)
     
    final void
    onSpin(org.apache.wicket.ajax.AjaxRequestTarget target, String value)
    Triggered on 'spin' event
    void
    onSpin(org.apache.wicket.ajax.AjaxRequestTarget target, T value)
     
    void
    onStop(org.apache.wicket.ajax.AjaxRequestTarget target)
    Triggered on 'stop' event

    Methods inherited from class com.googlecode.wicket.jquery.ui.form.spinner.Spinner

    getCulture, onBeforeRender, onConfigure, onConfigure, onInitialize, setCulture, setMax, setMax, setMin, setMin, setPage, setStep

    Methods inherited from class org.apache.wicket.markup.html.form.TextField

    getInputTypes, onComponentTag

    Methods inherited from class org.apache.wicket.markup.html.form.AbstractTextComponent

    convertInput, getConvertEmptyInputStringToNull, isInputNullable, onBeforeRender, setConvertEmptyInputStringToNull

    Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

    add, add, checkRequired, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

    Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

    getLabel

    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, onRender, queue, remove, remove, removeAll, renderAll, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, 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

  • Constructor Details

    • AjaxSpinner

      public AjaxSpinner(String id, Class<T> type)
      Constructor
      Parameters:
      id - the markup id
      type - type for field validation

    • AjaxSpinner

      public AjaxSpinner(String id, com.googlecode.wicket.jquery.core.Options options, Class<T> type)
      Constructor
      Parameters:
      id - the markup id
      options - the Options
      type - Type for field validation

    • AjaxSpinner

      public AjaxSpinner(String id, org.apache.wicket.model.IModel<T> model, Class<T> type)
      Constructor
      Parameters:
      id - the markup id
      model - the IModel
      type - type for field validation

    • AjaxSpinner

      public AjaxSpinner(String id, org.apache.wicket.model.IModel<T> model, com.googlecode.wicket.jquery.core.Options options, Class<T> type)
      Constructor
      Parameters:
      id - the markup id
      model - the IModel
      options - the Options
      type - Type for field validation

  • Method Details

    • isOnSpinEventEnabled

      public boolean isOnSpinEventEnabled()
      Description copied from interface: ISpinnerListener
      Indicates whether the 'spin' event is enabled.
      If true, the ISpinnerListener.onSpin(AjaxRequestTarget, String) event will be triggered
      Specified by:
      isOnSpinEventEnabled in interface ISpinnerListener
      Returns:
      false by default

    • isOnStopEventEnabled

      public boolean isOnStopEventEnabled()
      Description copied from interface: ISpinnerListener
      Indicates whether the 'stop' event is enabled.
      If true, the ISpinnerListener.onStop(AjaxRequestTarget) event will be triggered
      Specified by:
      isOnStopEventEnabled in interface ISpinnerListener
      Returns:
      false by default

    • convertValue

      public T convertValue(String value)
      Converts the supplied value using the type converter
      Parameters:
      value - the string value to convert
      Returns:
      the converted value

    • onSpin

      public final void onSpin(org.apache.wicket.ajax.AjaxRequestTarget target, String value)
      Triggered on 'spin' event
      Warning: onSpin converts the input but does not process it (no validation, no model update)
      Specified by:
      onSpin in interface ISpinnerListener
      Parameters:
      target - the AjaxRequestTarget
      value - the value

    • onSpin

      public void onSpin(org.apache.wicket.ajax.AjaxRequestTarget target, T value)

    • onStop

      public void onStop(org.apache.wicket.ajax.AjaxRequestTarget target)
      Description copied from interface: ISpinnerListener
      Triggered on 'stop' event
      Specified by:
      onStop in interface ISpinnerListener
      Parameters:
      target - the AjaxRequestTarget

    • newWidgetBehavior

      public JQueryUIBehavior newWidgetBehavior(String selector)
      Specified by:
      newWidgetBehavior in interface com.googlecode.wicket.jquery.core.IJQueryWidget
      Overrides:
      newWidgetBehavior in class Spinner<T extends Number>