Value

Value

new Value(optionsopt)

Source:
Properties:
Name Type Attributes Default Description
options.value Number <optional>
 0

The value.
options.format function <optional>
 function (v) { return v; }

A formatting function used to display the value.
options.size Null | Integer <optional>
 1

Size attribute of the input element. null to unset.
options.maxlength Null | Integer <optional>
 null

Maxlength attribute of the input element. null to unset.
options.set function <optional>
 function (val) { return parseFloat(val || 0); }

A function which is called to parse user input.
options.auto_select Boolean <optional>
 false

Select the entire text if clicked .
options.readonly Boolean <optional>
 false

Sets the readonly attribute.
options.placeholder String <optional>
 ""

Sets the placeholder attribute.
options.type String <optional>
 "text"

Sets the type attribute. Type can be either text or password.
options.editmode String <optional>
 "onenter"

Sets the event to trigger the userset event. Can be one out of onenter or immediate.
options.autocomplete String | Boolean false}

Set a unique identifier to enable browsers internal auto completion.
options.tab_to_set Boolean false}

Set the value if user hits TAB.

Value is a formatted and editable text field displaying values as strings or numbers.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 { }

An object containing initial options.

Extends

Members

_input :HTMLInputElement

Source:

The input element. Has class aux-input.

Type:
  • HTMLInputElement

element :HTMLDivElement

Source:

The main DIV container. Has class aux-value.

Type:
  • HTMLDivElement

Methods

addChild(child)

Source:
Inherited From:
See:

Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.

Parameters:
Name Type Description
child Widget

The child to add.
Fires:
  • Widget#event:child_added

addChildren(a)

Source:
Inherited From:

Registers an array of widgets as children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

allChildren()

Source:
Inherited From:

Returns an array of all children.

appendChild(child)

Source:
Inherited From:

Appends child.element to the widget element and registers child as a child widget.

Parameters:
Name Type Description
child Widget

The child widget to append.

appendChildren(children)

Source:
Inherited From:

Calls Widget#appendChild for an array of widgets.

Parameters:
Name Type Description
children Array.<Widget>

The child widgets to append.

destroy()

Source:
Overrides:

Dispose of this Widget.

destroyAndRemove()

Source:
Inherited From:

Dispose of this Widget and remove it from the DOM.

disableTansitions()

Source:
Inherited From:

Disable CSS transitions.

enableDraw()

Source:
Overrides:

Schedules this widget for drawing.

Fires:

enableDrawChildren()

Source:
Inherited From:

Enables rendering for all children of this widget.

enableTransitions()

Source:
Inherited From:

Enable CSS transitions.

forceHide()

Source:
Inherited From:

Hide the widget immediately by applying the class aux-hide. Does not call disableDraw().

forceShow()

Source:
Inherited From:

Show the widget immediately by applying the class aux-show. Does not call enableDraw().

getStyle()

Source:
Inherited From:

Returns the computed style of this widget's DOM element.

hidden()

Source:
Inherited From:

Returns the current hidden status.

hide()

Source:
Inherited From:

Hide the widget. This will result in the class aux-hide being applied to this widget in the next rendering step.

invalidate(key)

Source:
Inherited From:

Invalidates an option and triggers a redraw() call.

Parameters:
Name Type Description
key string

invalidateAll()

Source:
Inherited From:

Invalidates all dependencies which will trigger all renderers to rerun.

observeResize(cb)

Source:
Inherited From:

Calls a callback whenever the widget resizes. This method will trigger one resize.

Parameters:
Name Type Description
cb function

removeChild(child)

Source:
Inherited From:

Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.

Parameters:
Name Type Description
child Widget

The child to remove.
Fires:
  • Widget#event:child_removed

removeChildren(a)

Source:
Inherited From:

Removes an array of children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

set(key, value)

Source:
Inherited From:

Sets an option.

Parameters:
Name Type Description
key string

The option name.
value

The option value.

setStyle()

Source:
Inherited From:

Sets a CSS style property in this widget's DOM element.

show()

Source:
Inherited From:

Make the widget visible. This will apply the class aux-show during the next rendering step.

toggleHidden()

Source:
Inherited From:

Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.

transitionsDisabled()

Source:
Inherited From:

Returns true if transitions are currently disabled on this widget.

visibleChildren()

Source:
Inherited From:

Returns an array of all visible children.

Events

destroy

Source:
Inherited From:

Is fired when a widget is destroyed.

doubleclick

Source:
Inherited From:

Is fired after a double click appeared. Set dblclick to 0 to disable click event handling.

Parameters:
Name Type Description
event string

The browsers MouseEvent.

GenericDOMEvents

Source:
Inherited From:

Generic DOM events. Please refer to W3Schools for further details.

hide

Source:
Inherited From:

The hide event is emitted when a widget is hidden and is not rendered anymore. This happens both with browser visibility changes and also internally when using layout widgets such as Pager.

initialized

Source:
Inherited From:

Is fired when a widget is initialized.

resize

Source:
Inherited From:

The resize event is emitted whenever a widget is being resized. This event can be used to e.g. measure its new size. Note that some widgets do internal adjustments after the resize event. If that is relevant, the Widget#resized event can be used instead.

resized

Source:
Inherited From:

The resized event is emitted after each rendering frame, which was triggered by a resize event.

set

Source:
Inherited From:

The set event is emitted when an option was set using the Widget#set method. The arguments are the option name and its new value.

Note that this happens both for user interaction and programmatical option changes.

show

Source:
Inherited From:

The show event is emitted when a widget is shown and is being rendered. This is the counterpart to Widget#hide.

useraction

Source:

The useraction event is emitted when a widget gets modified by user interaction. The event is emitted for the option value.

Parameters:
Name Type Description
name string

The name of the option which was changed due to the users action
value mixed

The new value of the option

valueclicked

Source:

Is fired when the value was clicked.

Parameters:
Name Type Description
value number

The value of the widget.

valuedone

Source:

Is fired when editing of the value ends.

Parameters:
Name Type Description
value string

The new value of the widget.

valueescape

Source:

Is fired when the ESC key was pressed while editing the value.

Parameters:
Name Type Description
value string

The new value of the widget.

valueset

Source:

Is fired after the value has been set and editing has ended.

Parameters:
Name Type Description
value string

The new value of the widget.

valuetyping

Source:

Is fired when the user hits a key while editing the value.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.
value string

The new value of the widget.

visibility

Source:
Inherited From:

Is fired when the visibility state changes. The first argument is the visibility state, which is either true or false.