Class \Prado\Web\UI\WebControls\TSlider

TSlider class

TSlider displays a slider for numeric input purpose. A slider consists of a 'track', which define the range of possible value, and a 'handle' which can slide on the track, to select a value in the range. The track can be either Horizontal or Vertical, depending of the \Prado\Web\UI\WebControls\SetDirection property. By default, it's horizontal.

The range boundaries are defined by \Prado\Web\UI\WebControls\SetMinValue and \Prado\Web\UI\WebControls\SetMaxValue properties. The default range is from 0 to 100. The \Prado\Web\UI\WebControls\SetStepSize property can be used to define the step between 2 values inside the range. Notice that this step will be recomputed if there is more than 200 values between the range boundaries. You can also provide the allowed values by setting the \Prado\Web\UI\WebControls\SetValues array.

A 'Progress Indicator' can be displayed within the track with the \Prado\Web\UI\WebControls\SetProgressIndicator property.

The TSlider control can be easily customized using CssClasses. You can provide your own css file, using the \Prado\Web\UI\WebControls\SetCssUrl property. The css class for TSlider can be set by the \Prado\Web\UI\WebControls\setCssClass property. Default value is "Slider HorizontalSlider" for an horizontal slider, and "Slider VerticalSlider" for a vertical one.

If \Prado\Web\UI\WebControls\SetAutoPostBack property is true, postback is sent as soon as the value changed.

TSlider raises the onValueChanged event when the value of the slider has changed during postback.

You can also attach ClientSide javascript events handler to the slider :

ClientSide.onSlide is called when the handle is slided on the track. You can get the current value in the value javascript variable. You can use this event to update on client side a label with the current value
ClientSide.onChange is called when the slider value has changed (at the end of a move).

Class hierarchy

\Prado\Web\UI\WebControls\TSlider implements IPostBackDataHandler, IDataRenderer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Christophe Boulain <Christophe.Boulain@gmail.com>
Since: 3.1.1

Methods summary
`public`	`getAutoPostBack() : bool`
`public`	`getClientSide() : TSliderClientScript` Gets the TSliderClientScript to set the TSlider event handlers. The slider on the client-side supports the following events. `OnSliderMove` -- raised when the slider is moved. `OnSliderChanged` -- raised when the slider value is changed You can attach custom javascript code to each of these events
`public`	`getCssUrl() : string`
`public`	`getData() : float` Returns the value of the TSlider control. This method is required by IDataRenderer. It is the same as getValue().
`public`	`getDataChanged() : bool` Returns a value indicating whether postback has caused the control data change. This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
`public`	`getDirection() : TSliderDirection`
`public`	`getMaxValue() : float`
`public`	`getMinValue() : float`
`public`	`getProgressIndicator() : bool`
`public`	`getStepSize() : float`
`public`	`getTagName() : string` Returns the tag name used for this control.
`public`	`getValue() : float`
`public`	`getValues() : array<string\|int, mixed>`
`public`	`loadPostData(string $key, array<string\|int, mixed> $values) : bool` Loads user input data. This method is primarly used by framework developers.
`public`	`onPreRender(mixed $param) : mixed` Registers CSS and JS. This method is invoked right before the control rendering, if the control is visible.
`public`	`onValueChanged(TEventParameter $param) : mixed` Raises <b>OnValueChanged</b> event. This method is invoked when the \Prado\Web\UI\WebControls\getValue property changes on postback. If you override this method, be sure to call the parent implementation to ensure the invocation of the attached event handlers.
`public`	`raisePostDataChangedEvent() : mixed` Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when \Prado\Web\UI\WebControls\getValue property is changed on postback. This method is primarly used by framework developers.
`public`	`renderContents(mixed $writer) : mixed` Render the body content
`public`	`setAutoPostBack(bool $value) : mixed` Sets the value indicating if postback automatically. An automatic postback to the server will occur whenever the user modifies the slider value.
`public`	`setCssUrl(string $value) : mixed`
`public`	`setData(string $value) : mixed` Sets the value of the TSlider control. This method is required by IDataRenderer. It is the same as setValue().
`public`	`setDirection(TSliderDirection $value) : mixed`
`public`	`setMaxValue(float $value) : mixed`
`public`	`setMinValue(float $value) : mixed`
`public`	`setProgressIndicator(bool $value) : mixed`
`public`	`setStepSize(float $value) : mixed` Sets the step size used to determine the places where the slider handle can stop at. An evenly distributed stop marks will be generated according to \Prado\Web\UI\WebControls\getMinValue, \Prado\Web\UI\WebControls\getMaxValue and StepSize. To use uneven stop marks, set \Prado\Web\UI\WebControls\setValues.
`public`	`setValue(float $value) : mixed`
`public`	`setValues(array<string\|int, mixed> $value) : mixed` Sets the possible values that the slider can take. If this is set, \Prado\Web\UI\WebControls\setStepSize will be ignored. The latter generates a set of evenly distributed candidate values.
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Add the specified css classes to the track
`protected`	`createClientScript() : TSliderClientScript`
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getSliderOptions() : array<string\|int, mixed>` Get javascript sliderr options.
`protected`	`registerSliderClientScript() : mixed` Registers the javascript code to initialize the slider.
`protected`	`registerStyleSheet() : mixed` Registers the CSS relevant to the TSlider. It will register the CSS file specified by \Prado\Web\UI\WebControls\getCssUrl. If that is not set, it will use the default CSS.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`MAX_STEPS`	`200`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TSlider

Class hierarchy

`OnSliderMove` -- raised when the slider is moved.

`OnSliderChanged` -- raised when the slider value is changed

Classes

Interfaces

Traits

Class \Prado\Web\UI\WebControls\TSlider

Class hierarchy

OnSliderMove -- raised when the slider is moved.

OnSliderChanged -- raised when the slider value is changed

`OnSliderMove` -- raised when the slider is moved.

`OnSliderChanged` -- raised when the slider value is changed