Class JSSpinner
Extends
JSComponent.
Defined in: toolkit.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
JSSpinner(preferences, spanElement, options)
A spinner component with -+ buttons able to decrease / increase edtied value.
|
| Method Attributes | Method Name and Description |
|---|---|
|
getValue()
|
|
|
setEnabled(enabled)
Enables or disables this component.
|
|
|
setFormat(format)
|
|
|
setMaximum(maximum)
|
|
|
setMinimum(minimum)
|
|
|
setNullable(nullable)
|
|
|
setStepSize(stepSize)
|
|
|
setValue(value)
|
- Methods borrowed from class JSComponent:
- attachChildComponent, buildHtmlFromTemplate, dispose, findElement, findElements, getElement, getHTMLElement, getLocalizedLabelText, getUserPreferences, registerEventListener, registerPropertyChangeListener
Class Detail
JSSpinner(preferences, spanElement, options)
A spinner component with -+ buttons able to decrease / increase edtied value.
Author: Louis Grignon, Emmanuel Puybaret.
Author: Louis Grignon, Emmanuel Puybaret.
- Parameters:
- {UserPreferences} preferences
- the current user preferences
- {HTMLElement} spanElement
- span element on which the spinner is installed
- {{format?: Format|nullable?: boolean|value?: number|minimum?: number|maximum?: number|stepSize?: number}} options Optional
- - format: number format to be used for this input - default to DecimalFormat for current content - nullable: false if null/undefined is not allowed - default false - value: initial value, - minimum: minimum number value, - maximum: maximum number value, - stepSize: step between values when increment / decrement using UI - default 1
Method Detail
{Format}
getFormat()
- Returns:
- {Format} format used to format the value of this spinner
{HTMLInputElement}
getInputElement()
- Returns:
- {HTMLInputElement} underlying input element
{number}
getMaximum()
- Returns:
- {number} maximum of this spinner
{number}
getMinimum()
- Returns:
- {number} minimum of this spinner
{number}
getStepSize()
- Returns:
- {number} step size of this spinner
{Object}
getValue()
- Returns:
- {Object} the value of this spinner
{boolean}
isNullable()
- Returns:
- {boolean}
trueif this spinner may contain no value
setEnabled(enabled)
Enables or disables this component.
- Parameters:
- {boolean} enabled
setFormat(format)
- Parameters:
- {Format} format
- format used to format the value of this spinner
setMaximum(maximum)
- Parameters:
- {number} maximum
- maximum value of this spinner
setMinimum(minimum)
- Parameters:
- {number} minimum
- minimum value of this spinner
setNullable(nullable)
- Parameters:
- {boolean} nullable
trueif this spinner may contain no value
setStepSize(stepSize)
- Parameters:
- {number} stepSize
- step size of this spinner
setValue(value)
- Parameters:
- {Object} value
- the value of this spinner
