TK.Window

The close button.

A TK.Container for the window content.

The {TK.Drag} module.

The bottom footer bar.

The top header bar.

A TK.Icon widget to display the window icon.

The maximize button.

The maximizehorizontal button.

The maximizevertical button.

The minimize button.

The {TK.Resize} module.

The shrink button.

A TK.Icon acting as handle for window resize.

A TK.Label to display the window status.

A TK.Label to display the window title.

The main DIV element. Has class toolkit-container

Appends a new child to the window content area.

Toggles the overall maximize state of the window.

Toggles the horizontal maximize state of the window.

Toggles the vertical maximize state of the window.

Toggles the minimize state of the window.

Toggles the shrink state of the window.

Calls TK.Container#append_child for an array of widgets.

Immediately switches the display state of this container to hide. Unlike TK.Container#hide this method does not perform the hiding transition and immediately modifies the DOM by setting the toolkit-hide class.

Immediately switches the display state of this container to show. Unlike TK.Container#hide this method does not perform the hiding transition and immediately modifies the DOM by setting the toolkit-show class.

Starts the transition of the display_state to hide.

Switches the hidden state of a child to hidden. The argument is either the child index or the child itself.

Starts the transition of the display_state to show.

Switches the hidden state of a child to shown. The argument is either the child index or the child itself.

Toggles the hidden state of a child. The argument is either the child index or the child itself.

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.

Returns the computed style of this widgets DOM element.

Returns the current hidden status.

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

Removes an array of children.

Sets an option.

Sets a CSS style property in this widgets DOM element.

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.

Register an event handler.

Add multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.

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.

Fires an event.

Fires several events.

Get the value of an option.

Test if the event descriptor has some handler functions in the queue.

Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.

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.

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.

The user clicked the close button.

The dimensions of the window changed.

The user is dragging the window.

The footer changed.

The user double-clicked on the header.

The header changed.

The user clicked the maximize button.

The user clicked the maximize-horizontal button.

The user clicked the maximize-vertical button.

The user clicked the minimize button.

The position of the window changed.

The user resizes the window.

The user clicked the shrink button.

The user starts dragging the window.

The user starts resizing the window.

The user stops dragging the window.

The user stops resizing the window.

Is fired when the container is hidden.

Is fired when the container is shown.

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.

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.

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.

Is fired when an element is delegated.

Is fired when an option is set.