Package 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<Integer>
com.googlecode.wicket.jquery.ui.form.slider.Slider
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.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<Integer,org.apache.wicket.markup.html.form.FormComponent<Integer>>, org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>, 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:
AjaxSlider
public class Slider extends AbstractSlider<Integer>
Provides a jQuery slider based on a FormComponentPanel
Author:
Sebastien Briquet - sebfz1
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.apache.wicket.markup.html.form.AbstractTextComponent<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_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
    Slider(String id)
    Constructor
    Slider(String id, org.apache.wicket.model.IModel<Integer> model)
    Constructor
    Slider(String id, org.apache.wicket.model.IModel<Integer> model, org.apache.wicket.markup.html.basic.Label label)
    Constructor
    Slider(String id, org.apache.wicket.model.IModel<Integer> model, org.apache.wicket.markup.html.form.TextField<Integer> input)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    convertInput()
     
    protected String
    getLabelPattern()
    Get the label pattern to be used to display the value.
    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.
    void
    onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
     
    protected void
    onInitialize()
     
    Slider
    setRange(Slider.Range range)
    Sets the Slider.Range
    Slider
    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 AbstractSlider.setMin(Integer) and AbstractSlider.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 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, 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, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, 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, 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.IGenericComponent

    getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

    Methods inherited from interface org.apache.wicket.IQueueRegion

    dequeue, getRegionMarkup, newDequeueContext

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Field Details

    • input

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

  • Constructor Details

    • Slider

      public Slider(String id)
      Constructor
      Parameters:
      id - the markup id

    • Slider

      public Slider(String id, org.apache.wicket.model.IModel<Integer> model)
      Constructor
      Parameters:
      id - the markup id
      model - the IModel

    • Slider

      public Slider(String id, org.apache.wicket.model.IModel<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(String id, org.apache.wicket.model.IModel<Integer> model, org.apache.wicket.markup.html.form.TextField<Integer> input)
      Constructor
      Parameters:
      id - the markup id
      model - the IModel
      input - the TextField that will host the slider value when being updated.

  • Method Details

    • convertInput

      public void convertInput()
      Specified by:
      convertInput in class AbstractSlider<Integer>

    • setRangeValidator

      public Slider setRangeValidator(org.apache.wicket.validation.validator.RangeValidator<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 marked as 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<Integer>
      Parameters:
      validator - the RangeValidator
      Returns:
      this

    • getLabelPattern

      protected 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<Integer>

    • onConfigure

      public void onConfigure(com.googlecode.wicket.jquery.core.JQueryBehavior behavior)
      Specified by:
      onConfigure in interface com.googlecode.wicket.jquery.core.IJQueryWidget
      Overrides:
      onConfigure in class AbstractSlider<Integer>

    • setRange

      public Slider setRange(Slider.Range range)
      Sets the Slider.Range
      Parameters:
      range - the Range
      Returns:
      this, for chaining

    • newInputFragment

      protected org.apache.wicket.markup.html.panel.Fragment newInputFragment(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<Integer>
      Parameters:
      id - the markup id
      Returns:
      the empty-fragment by default