new ValueButton(optionsopt)
This widget combines a TK.Button, a TK.Scale and a TK.Value. TK.ValueButton uses TK.DragValue and TK.ScrollValue for setting its value. It inherits all options of TK.DragValue and TK.Scale.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ } | An object containing initial options. |
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options.value |
Number |
<optional> |
0 | The value of the widget. |
options.value_format |
Number |
<optional> |
function (val) { return val.toFixed(2); } | Callback to format the value label. |
options.value_size |
Number |
<optional> |
5 | Amount of digits of the value input. |
options.direction |
String |
<optional> |
"polar" | Direction for changing the value. Can be "polar", "vertical" or "horizontal". See TK.DragValue for more details. |
options.blind_angle |
Number |
<optional> |
20 | If |
options.rotation |
Number |
<optional> |
45 | Defines the angle of the center of the positive value changes. 0 means straight upward. For instance, a value of 45 leads to increasing value when moving towards top and right. See TK.DragValue for more details. |
options.snap |
Number |
<optional> |
0.01 | Snap value while dragging. |
options.basis |
Number |
<optional> |
300 | Distance to drag between |
Source: |
Extends
Members
drag :TK.DragValue
The TK.DragValue module.
Source: |
element :HTMLDivElement
The main DIV container.
Has class toolkit-valuebutton
.
Overrides: | |
Source: |
scale :TK.Scale
The TK.Scale showing the value.
Source: |
scroll :TK.ScrollValue
The ScrollValue module.
Source: |
value :TK.Value
The value widget for editing the value manually.
Source: |
Members inherited from TK.Button
icon :TK.Icon
The TK.Icon widget.
label :TK.Label
The TK.Label of the button.
Methods inherited from TK.Widget
add_child(child)
Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.
add_children(a)
Registers an array of widgets as children.
all_children()
Returns an array of all children.
enable_draw()
Schedules this widget for drawing.
force_hide()
This is an alias for hide, which may be overloaded. See TK.Container for an example.
force_show()
This is an alias for hide, which may be overloaded. See TK.Container for an example.
get_style()
Returns the computed style of this widgets DOM element.
hidden()
Returns the current hidden status.
hide()
Make the widget hidden. This does not modify the DOM, instead it will stop rendering this widget. Options changed after calling hide will only be rendered (i.e. applied to the DOM) when the widget is made visible again using TK.Widget#show.
remove_child(child)
Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.
remove_children(a)
Removes an array of children.
set(key, value)
Sets an option.
set_style()
Sets a CSS style property in this widgets DOM element.
show()
Make the widget visible. This does not modify the DOM, instead it will only schedule the widget for rendering.
toggle_hidden()
TK.Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.
visible_children()
Returns an array of all visible children.
widgetize()
Set the DOM elements of this widgets. This method is usually only used internally. Basically it means to add the id from options and set a basic CSS class. If delegate is true, basic events will be delegated from the element to the widget instance if classify is true, CSS functions will be bound to the widget instance.
Methods inherited from TK.Base
add_event(event, func, prevent, stop)
Register an event handler.
add_events(events, func)
Add multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.
delegate_events(element) → {HTMLElement}
Delegates all occuring DOM events of a specific DOM node to the widget. This way the widget fires e.g. a click event if someone clicks on the given DOM node.
destroy()
Destroys all event handlers and the options object.
fire_event(event, …args)
Fires an event.
fire_events(events)
Fires several events.
get(key)
Get the value of an option.
has_event_listeners(event) → {boolean}
Test if the event descriptor has some handler functions in the queue.
remove_event(event, fun)
Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.
remove_events(events, func)
Remove multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.
set_options(optionsopt)
Merges a new options object into the existing one, including deep copies of objects. If an option key begins with the string "on" it is considered as event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.
userset(key, value)
Sets an option by user interaction. Emits the userset
event. The userset
event can be cancelled (if an event handler
returns false
), in which case the option is not set.
Returns true
if the option was set, false
otherwise. If the option was set, it will emit a useraction
event.
Events
doubleclick
Is fired when the user doubleclicks the valuebutton in order to to reset to initial value. The Argument is the new value.
Parameters:
Name | Type | Description |
---|---|---|
value |
number | The value of the widget. |
Overrides: | |
Source: |
useraction
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 |
Source: |
valueedit
Is fired when the user starts editing the value manually.
Parameters:
Name | Type | Description |
---|---|---|
value |
number | The value of the widget. |
Source: |
valueedit
Is fired when the user starts editing the value manually
Parameters:
Name | Type | Description |
---|---|---|
value |
number | The value of the widget. |
Source: |
valueset
Is fired when the user finished editing the value manually.
Parameters:
Name | Type | Description |
---|---|---|
value |
number | The value of the widget. |
Source: |
valueset
Is fired when the user finished editing the value manually
Parameters:
Name | Type | Description |
---|---|---|
value |
number | The value of the widget. |
Source: |
Events inherited from TK.Widget
GenericDOMEvents
Generic DOM events. Please refer to W3Schools for further details.
classified
Is fired when a widget is classified.
destroy
Is fired when a widget is destroyed.
hide
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 TK.Pager.
initialized
Is fired when a widget is initialized.
redraw
Is fired when a redraw is executed.
resize
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 TK.Widget#resized event can
be used, instead.
resized
The resized
event is emitted after each rendering frame, which was triggered by
a resize event.
set
The set
event is emitted when an option was set using the TK.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
The show
event is emitted when a widget is shown and is being rendered. This is the
counterpart to TK.Widget#hide.
stylized
Is fired when a widget is stylized.
visibility
Is fired when the visibility state changes. The first argument
is the visibility state, which is either true
or false
.
widgetize
Is fired when a widget is widgetized.
Events inherited from TK.Base
delegated
Is fired when an element is delegated.
set_[option]
Is fired when an option is set.