new State(optionsopt)

The TK.State widget is a multi-functional adaption of a traditional LED. It is able to show different colors as well as on/off states. The "brightness" can be set seamlessly. Classes can be used to display different styles. TK.State extends TK.Widget.

The LED effect is implemented as a DIV element, which is overlayed by a DIV element with class toolkit-mask. options.state changes the opacity of the mask element.

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

An object containing initial options.

Name Type Attributes Default Description
options.state Number <optional>

The state. To toggle between on|off set to 1|0. Set to fractions of 1 to change "brightness", e.g. 0.5. Values > 0 trigger setting the class toolkit-state-on, while a state of 0 results in class toolkit-state-off.

options.color String | Boolean <optional>

A CSS color string for the state LED or false to set the background via external CSS.




_mask :HTMLDivElement

A DIV for masking the background. Has class toolkit-mask.


element :HTMLDivElement

The main DIV container. Has class toolkit-state.


Methods inherited from TK.Widget


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


Registers an array of widgets as children.


Returns an array of all children.


Schedules this widget for drawing.


This is an alias for hide, which may be overloaded. See TK.Container for an example.


This is an alias for hide, which may be overloaded. See TK.Container for an example.


Returns the computed style of this widgets DOM element.


Returns the current hidden status.


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.


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


Removes an array of children.

set(key, value)

Sets an option.


Sets a CSS style property in this widgets DOM element.


Make the widget visible. This does not modify the DOM, instead it will only schedule the widget for rendering.


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


Returns an array of all visible children.


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.


Destroys all event handlers and the options object.

fire_event(event, …args)

Fires an event.


Fires several events.


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.


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 inherited from TK.Widget


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


Is fired when a widget is classified.


Is fired when a widget is destroyed.


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


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.


Is fired when a widget is initialized.


Is fired when a redraw is executed.


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.


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


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.


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


Is fired when a widget is stylized.


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


Is fired when a widget is widgetized.

Events inherited from TK.Base


Is fired when an element is delegated.


Is fired when an option is set.