com.googlecode.wicket.jquery.ui.form.slider

Class AbstractSlider<T>

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.FormComponentPanel<T>

com.googlecode.wicket.jquery.ui.form.slider.AbstractSlider<T>

Type Parameters:

T - the model object type

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryWidget, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T,org.apache.wicket.markup.html.form.FormComponent<T>>, org.apache.wicket.IQueueRegion, 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

Direct Known Subclasses:

RangeSlider, Slider

public abstract class AbstractSlider<T>
extends org.apache.wicket.markup.html.form.FormComponentPanel<T>
implements com.googlecode.wicket.jquery.core.IJQueryWidget

Base class for implementing jQuery slider(s)

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSlider.SliderBehavior Provides a jQuery slider JQueryBehavior

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 and Description
protected org.apache.wicket.markup.html.basic.Label	label the div on which the slider behavior will be applied to
protected String	labelId
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

Constructor Summary

Constructors

Constructor and Description
AbstractSlider(String id) Constructor
AbstractSlider(String id, org.apache.wicket.model.IModel<T> model) Constructor
AbstractSlider(String id, org.apache.wicket.model.IModel<T> model, org.apache.wicket.markup.html.basic.Label label) Constructor

Method Summary

Modifier and Type	Method and Description
abstract void	convertInput()
protected org.apache.wicket.markup.html.panel.Fragment	newInputFragment(String id) Gets a new Fragment containing the input Overridden methods should provide a Fragment containing input(s) when no input(s) has been specified in implementation constructors.
com.googlecode.wicket.jquery.core.JQueryBehavior	newWidgetBehavior(String selector)
void	onBeforeRender(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
void	onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
protected void	onInitialize()
AbstractSlider<T>	setLabelId(String markupId) Sets the label's markupId on which the current slide value will be displayed. Warning: It cannot be set/changed once the Component has been initialized.
AbstractSlider<T>	setMax(Integer max) Sets the max value
AbstractSlider<T>	setMin(Integer min) Sets the min value
AbstractSlider<T>	setOrientation(Orientation orientation) Sets the Orientation
abstract AbstractSlider<T>	setRangeValidator(org.apache.wicket.validation.validator.RangeValidator<Integer> validator) Adds a RangeValidator so slider value(s) are valid only if comprised between minimum and maximum. Warning: it does not define the minimum and maximum values the slider can slide on, but only valid ones. To define the minimum and maximum values the slider can slide on, use setMin(Integer) and setMax(Integer) Dev note: this method is marked as abstract to make sure the developer that will add the validator to the right input(s) in onInitialize()
AbstractSlider<T>	setStep(Integer step) Sets the step value

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

checkRequired, clearInput, newMarkupSourcingStrategy, onComponentTag

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

add, add, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onRequired, 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, 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, onAfterRender, onBeforeRender, onConfigure, 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.IQueueRegion

dequeue, getRegionMarkup, newDequeueContext

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 com.googlecode.wicket.jquery.core.Options options

label

protected org.apache.wicket.markup.html.basic.Label label

the div on which the slider behavior will be applied to

labelId

protected String labelId

Constructor Detail

AbstractSlider

public AbstractSlider(String id)

Constructor

Parameters:

id - the markup id

AbstractSlider

public AbstractSlider(String id,
                      org.apache.wicket.model.IModel<T> model)

Constructor

Parameters:

id - the markup id

model - the IModel

AbstractSlider

public AbstractSlider(String id,
                      org.apache.wicket.model.IModel<T> model,
                      org.apache.wicket.markup.html.basic.Label label)

Constructor

Parameters:

id - the markup id

model - the IModel

label - Label on which the current slide value will be displayed

Method Detail

convertInput

public abstract void convertInput()

Overrides:

convertInput in class org.apache.wicket.markup.html.form.FormComponent<T>

setRangeValidator

public abstract AbstractSlider<T> setRangeValidator(org.apache.wicket.validation.validator.RangeValidator<Integer> validator)

Adds a RangeValidator so slider value(s) are valid only if comprised between minimum and maximum.

Warning: it does not define the minimum and maximum values the slider can slide on, but only valid ones.
To define the minimum and maximum values the slider can slide on, use setMin(Integer) and setMax(Integer)

Dev note: this method is marked as abstract to make sure the developer that will add the validator to the right input(s) in onInitialize()

Parameters:

validator - the RangeValidator

Returns:

this

setLabelId

public final AbstractSlider<T> setLabelId(String markupId)

Sets the label's markupId on which the current slide value will be displayed.
Warning: It cannot be set/changed once the Component has been initialized.

Parameters:

markupId - the label's markupId

Returns:

this

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.MarkupContainer

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

newWidgetBehavior

public com.googlecode.wicket.jquery.core.JQueryBehavior newWidgetBehavior(String selector)

Specified by:

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

newInputFragment

protected org.apache.wicket.markup.html.panel.Fragment newInputFragment(String id)

Gets a new Fragment containing the input
Overridden methods should provide a Fragment containing input(s) when no input(s) has been specified in implementation constructors.

Parameters:

id - the markup id

Returns:

the empty-fragment by default

setMin

public AbstractSlider<T> setMin(Integer min)

Sets the min value

Parameters:

min - the min value

Returns:

this, for chaining

setMax

public AbstractSlider<T> setMax(Integer max)

Sets the max value

Parameters:

max - the max value

Returns:

this, for chaining

setStep

public AbstractSlider<T> setStep(Integer step)

Sets the step value

Parameters:

step - the step value

Returns:

this, for chaining

setOrientation

public AbstractSlider<T> setOrientation(Orientation orientation)

Sets the Orientation

Parameters:

orientation - the Orientation

Returns:

this, for chaining