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

Class Slider

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<java.lang.Integer>

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

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.IGenericComponent<java.lang.Integer>, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<java.lang.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:

AjaxSlider

public class Slider
extends AbstractSlider<java.lang.Integer>

Provides a jQuery slider based on a FormComponentPanel

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Slider.Range

Nested classes/interfaces inherited from class com.googlecode.wicket.jquery.ui.form.slider.AbstractSlider

AbstractSlider.SliderBehavior

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

IJQueryWidget.JQueryWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.wicket.markup.html.form.AbstractTextComponent<java.lang.Integer>	input

Fields inherited from class com.googlecode.wicket.jquery.ui.form.slider.AbstractSlider

label, labelId, 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_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
Slider(java.lang.String id) Constructor
Slider(java.lang.String id, org.apache.wicket.model.IModel<java.lang.Integer> model) Constructor
Slider(java.lang.String id, org.apache.wicket.model.IModel<java.lang.Integer> model, org.apache.wicket.markup.html.basic.Label label) Constructor
Slider(java.lang.String id, org.apache.wicket.model.IModel<java.lang.Integer> model, org.apache.wicket.markup.html.form.TextField<java.lang.Integer> input) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	convertInput()
protected java.lang.String	getLabelPattern() Get the label pattern to be used to display the value.
protected org.apache.wicket.markup.html.panel.Fragment	newInputFragment(java.lang.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.
void	onConfigure(JQueryBehavior behavior)
protected void	onInitialize()
Slider	setRange(Slider.Range range) Sets the Slider.Range
<W extends AbstractSlider<java.lang.Integer>> W	setRangeValidator(org.apache.wicket.validation.validator.RangeValidator<java.lang.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 AbstractSlider.setMin(Integer) and AbstractSlider.setMax(Integer) Dev note: this method is masked abstract to make sure the developer that will add the validator to the right input(s) in AbstractSlider.onInitialize()

Methods inherited from class com.googlecode.wicket.jquery.ui.form.slider.AbstractSlider

newWidgetBehavior, onBeforeRender, setLabelId, setMax, setMin, setOrientation, setStep

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

checkRequired, newMarkupSourcingStrategy, onComponentTag

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

add, add, clearInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, 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, setModel, setModelObject, 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

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, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, 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

Field Detail

input

protected org.apache.wicket.markup.html.form.AbstractTextComponent<java.lang.Integer> input

Constructor Detail

Slider

public Slider(java.lang.String id)

Constructor

Parameters:

id - the markup id

Slider

public Slider(java.lang.String id,
      org.apache.wicket.model.IModel<java.lang.Integer> model)

Constructor

Parameters:

id - the markup id

model - the IModel

Slider

public Slider(java.lang.String id,
      org.apache.wicket.model.IModel<java.lang.Integer> 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

Slider

public Slider(java.lang.String id,
      org.apache.wicket.model.IModel<java.lang.Integer> model,
      org.apache.wicket.markup.html.form.TextField<java.lang.Integer> input)

Constructor

Parameters:

id - the markup id

model - the IModel

input - the TextField that will host the slider value when being updated.

Method Detail

convertInput

protected void convertInput()

Specified by:

convertInput in class AbstractSlider<java.lang.Integer>

setRangeValidator

public <W extends AbstractSlider<java.lang.Integer>> W setRangeValidator(org.apache.wicket.validation.validator.RangeValidator<java.lang.Integer> validator)

Description copied from class: AbstractSlider

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 AbstractSlider.setMin(Integer) and AbstractSlider.setMax(Integer)

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

Specified by:

setRangeValidator in class AbstractSlider<java.lang.Integer>

Type Parameters:

W - the widget type

Parameters:

validator - the RangeValidator

Returns:

this

getLabelPattern

protected java.lang.String getLabelPattern()

Get the label pattern to be used to display the value. Should be overridden with care!
Note: the pattern is a javascript string, where the value is represented by "ui.value".

Returns:

default to ui.value

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class AbstractSlider<java.lang.Integer>

onConfigure

public void onConfigure(JQueryBehavior behavior)

Specified by:

onConfigure in interface IJQueryWidget

Overrides:

onConfigure in class AbstractSlider<java.lang.Integer>

setRange

public Slider setRange(Slider.Range range)

Sets the Slider.Range

Parameters:

range -

Returns:

Slider (this)

newInputFragment

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

Description copied from class: AbstractSlider

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.

Overrides:

newInputFragment in class AbstractSlider<java.lang.Integer>

Parameters:

id - the markup-id

Returns:

the empty-fragment by default