TK.Select

new Select(options)

TK.Select provides a button with a select list to choose from a list of entries.

Parameters:
Name Type Description
options Object
Properties:
Name Type Attributes Default Description
options.selected integer

The index of the selected entry.

options.value

The value of the selected entry.

options.auto_size boolean <optional>
true

If true, the drop-down button is auto-sized to be as wide as the longest entry.

options.entries Array <optional>
[]

The list of entries. Each entry is a an object with the two properties title and value.

Source:

Extends

Members

_arrow :HTMLDivElement

A DIV element displaaying a small arrow to click on in order to show the select list. Has class toolkit-arrow.

Source:

_list :HTMLListElement

A HTML list for displaying the entry titles. Has class toolkit-select-list.

Source:

element :HTMLDivElement

The main DIV container. Has class toolkit-select.

Overrides:
Source:

entries :Array

An array containing all entry objects with members title and value.

Source:

Members inherited from TK.Button

_cell :HTMLDivElement

An internal container for label and icon. Has class toolkit-cell

_icon :HTMLImageElement

The icon of the button. Has class toolkit-icon.

_label :HTMLDivElement

The label of the button. Has class toolkit-label.

Methods

(static) add_entry(entry)

Adds a single entry to the end of the list.

Parameters:
Name Type Description
entry mixed

A string to be displayed and used as the value or an object with members title and value.

Source:
Fires:

add_entries(entries)

Adds new entries to the end of the list to select from.

Parameters:
Name Type Description
entries Array

An array of entries to add at the end of the list to select from.

Source:

clear()

Remove all entries from the list.

Source:
Fires:
  • TK.Select#event:cleared

current() → {Object}

Get the currently selected entry.

Source:
Returns:

The entry object with the members title and value.

Type
Object

remove_entry(entry)

Remove an entry from the list.

Parameters:
Name Type Description
entry Object

The entry to be removed from the list.

Source:
Fires:
  • TK.Select#event:entryremoved

remove_id(id)

Remove an entry from the list by its ID.

Parameters:
Name Type Description
id int

The ID of the entry to be removed from the list.

Source:
Fires:
  • TK.Select#event:entryremoved

remove_title(title)

Remove an entry from the list by its title.

Parameters:
Name Type Description
title string

The title of the entry to be removed from the list.

Source:
Fires:
  • TK.Select#event:entryremoved

remove_value(value)

Remove an entry from the list by its value.

Parameters:
Name Type Description
value mixed

The value of the entry to be removed from the list.

Source:
Fires:
  • TK.Select#event:entryremoved

select(id)

Select an entry by its ID.

Parameters:
Name Type Description
id int

The ID of the entry to select.

Source:

select_value(value)

Select an entry by its value.

Parameters:
Name Type Description
value mixed

The value of the entry to select.

Source:

set_entries(entries)

Replaces the list to select from with an entirely new one.

Parameters:
Name Type Description
entries Array

An array of entries to set as the new list to select from.

Source:

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, func)

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.

Events

cleared

Is fired when the list is cleared.

Source:

entryadded

Is fired when a new entry is added to the list.

Parameters:
Name Type Description
entry Object

An object containing the members title and value.

Source:

entryremoved

Is fired when a new entry is added to the list.

Parameters:
Name Type Description
entry Object

An object containing the members title and value.

Source:

select

Is fired when a selection was made by the user. The arguments are the value of the entry, the id of the selected element and the title of the entry.

Parameters:
Name Type Description
value mixed

The value of the selected entry.

value number

The ID of the selected entry.

value string

The title of the selected entry.

Source:

useraction

The useraction event is emitted when a widget gets modified by user interaction. The event is emitted for the options selected and 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

Overrides:
Source:

Events inherited from TK.Widget

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.

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.