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

Class Spinner<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>

Type Parameters:

T - the type of the model object

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryCultureWidget, com.googlecode.wicket.jquery.core.IJQueryWidget, Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<T,FormComponent<T>>, IMetadataContext<Serializable,Component>, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

AjaxSpinner

public class Spinner<T extends Number>
extends TextField<T>
implements com.googlecode.wicket.jquery.core.IJQueryCultureWidget

Provides a jQuery spinner based on a TextField

Since:

1.5.0

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

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

AbstractTextComponent.ITextFormatProvider

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

com.googlecode.wicket.jquery.core.IJQueryWidget.JQueryWidget

Field Summary

Fields

Modifier and Type	Field	Description
protected com.googlecode.wicket.jquery.core.Options	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
Spinner(String id)	Constructor
Spinner(String id, com.googlecode.wicket.jquery.core.Options options)	Constructor
Spinner(String id, com.googlecode.wicket.jquery.core.Options options, Class<T> type)	Constructor
Spinner(String id, Class<T> type)	Constructor
Spinner(String id, IModel<T> model)	Constructor
Spinner(String id, IModel<T> model, com.googlecode.wicket.jquery.core.Options options)	Constructor
Spinner(String id, IModel<T> model, com.googlecode.wicket.jquery.core.Options options, Class<T> type)	Constructor
Spinner(String id, IModel<T> model, Class<T> type)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getCulture()
JQueryUIBehavior	newWidgetBehavior(String selector)
void	onBeforeRender(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
protected void	onConfigure()
void	onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
protected void	onInitialize()
Spinner<T>	setCulture(String culture)	Sets the culture to use for parsing and formatting the value. More: https://github.com/jquery/globalize
Spinner<T>	setMax(Number max)	Sets the max.
Spinner<T>	setMax(String max)	Sets the max. If Globalize is included, the max option canbe passed as a string which will be parsed based on the numberFormat and culture options; otherwise it will fall back to the native parseFloat() method. More: https://github.com/jquery/globalize
Spinner<T>	setMin(Number min)	Sets the min.
Spinner<T>	setMin(String min)	Sets the min. If Globalize is included, the min option can be passed as a string which will be parsed based on the numberFormat and culture options; otherwise it will fall back to the native parseFloat() method. More: https://github.com/jquery/globalize
Spinner<T>	setPage(Number steps)	Sets the number of steps to take when paging via the pageUp/pageDown methods.
Spinner<T>	setStep(Number size)	Sets the size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods.

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

Field Detail

options

protected final com.googlecode.wicket.jquery.core.Options options

Constructor Detail

Spinner

public Spinner(String id)

Constructor

Parameters:

id - the markup id

Spinner

public Spinner(String id,
               com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

options - the Options

Spinner

public Spinner(String id,
               Class<T> type)

Constructor

Parameters:

id - the markup id

type - type for field validation

Spinner

public Spinner(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

Spinner

public Spinner(String id,
               IModel<T> model)

Constructor

Parameters:

id - the markup id

model - the IModel

Spinner

public Spinner(String id,
               IModel<T> model,
               com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the IModel

options - the Options

Spinner

public Spinner(String id,
               IModel<T> model,
               Class<T> type)

Constructor

Parameters:

id - the markup id

model - the IModel

type - type for field validation

Spinner

public Spinner(String id,
               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 Detail

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class MarkupContainer

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Component

onConfigure

public void onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)

Specified by:

onConfigure in interface com.googlecode.wicket.jquery.core.IJQueryWidget

onBeforeRender

public void onBeforeRender(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)

Specified by:

onBeforeRender in interface com.googlecode.wicket.jquery.core.IJQueryWidget

setCulture

public Spinner<T> setCulture(String culture)

Sets the culture to use for parsing and formatting the value.
More: https://github.com/jquery/globalize

Specified by:

setCulture in interface com.googlecode.wicket.jquery.core.IJQueryCultureWidget

Parameters:

culture - the culture to be used

Returns:

this, for chaining

getCulture

public String getCulture()

Specified by:

getCulture in interface com.googlecode.wicket.jquery.core.IJQueryCultureWidget

setMin

public Spinner<T> setMin(Number min)

Sets the min.

Parameters:

min - the min

Returns:

this, for chaining

setMin

public Spinner<T> setMin(String min)

Sets the min.
If Globalize is included, the min option can be passed as a string which will be parsed based on the numberFormat and culture options; otherwise it will fall back to the native parseFloat() method.
More: https://github.com/jquery/globalize

Parameters:

min - the min

Returns:

this, for chaining

setMax

public Spinner<T> setMax(Number max)

Sets the max.

Parameters:

max - the max

Returns:

this, for chaining

setMax

public Spinner<T> setMax(String max)

Sets the max.
If Globalize is included, the max option canbe passed as a string which will be parsed based on the numberFormat and culture options; otherwise it will fall back to the native parseFloat() method.
More: https://github.com/jquery/globalize

Parameters:

max - the max

Returns:

this, for chaining

setPage

public Spinner<T> setPage(Number steps)

Sets the number of steps to take when paging via the pageUp/pageDown methods.

Parameters:

steps - the number of steps. Default is 10

Returns:

this, for chaining

setStep

public Spinner<T> setStep(Number size)

Sets the size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods. The element's step attribute is used if it exists and the option is not explicitly set.

Parameters:

size - the size of the step. Default is 1

Returns:

this, for chaining

newWidgetBehavior

public JQueryUIBehavior newWidgetBehavior(String selector)

Specified by:

newWidgetBehavior in interface com.googlecode.wicket.jquery.core.IJQueryWidget