TK.Pager

new Pager(optionsopt)

TK.Pager, also known as Notebook in other UI toolkits, provides multiple containers for displaying contents which are switchable via a TK.ButtonArray.

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

An object containing initial options.
Properties:
Name Type Attributes Default Description
options.position String <optional>
 "top"

The position of the ButtonArray. Can either be top, right, left or bottom.
options.pages Array.<Object> <optional>
 []

An array of objects with the following members:

Name Type Attributes Default Description
label String | Object <optional>
 ""

A string used as the buttons label or an object containing options for a TK.Button.
content TK.Container | DOMNode | String <optional>
  • The content of the page. Can be either an instance of TK.Container (or derivate), a DOMNode or a string which gets wrapped in a new TK.Container.
options.show Integer <optional>
 -1

The page to show.
Source:
Example
var pager = new TK.Pager({
 pages: [
  {
    label: "Empty Page 1",
    content: document.createElement("span")
  },
  {
    label: { label:"Foobar", class:"foobar" },
    content: "<h1>Foobar</h1><p>Lorem ipsum dolor sit amet</p>"
  }
 ]
});

Extends

Members

_buttonarray_wrapper :HTMLDivElement

An internal container for layout purposes containing the #TK.ButtonArray. Has classes toolkit-buttonarray-wrapper and toolkit-wrapper.

Source:

_clip :HTMLDivElement

The clipping area containing the pages. Has class toolkit-clip.

Source:

_clip :HTMLDivElement

The clipping of the pages. Has class toolkit-clip.

Source:

_container_wrapper :HTMLDivElement

An internal container for layout purposes containing the _clip element. Has classes toolkit-wrapper and toolkit-container-wrapper.

Source:

buttonarray

The TK.ButtonArray instance acting as the menu.

Source:

element

The main DIV element. Has the class toolkit-pager.

Overrides:
Source:

Methods

add_page(button, content, optionsopt, position)

Adds a TK.Container to the pager and a corresponding TK.Button to the pagers TK.ButtonArray.

Parameters:
Name Type Attributes Default Description
button string | Object

A string with the TK.Buttons label or an object containing options for the TK.Button instance.
content TK.Widget | Class | string

The content of the page. Either a TK.Container (or derivate) widget, a DOMNode (needs option options to be set) or a string which gets wrapped in a new TK.Container with options from argument options.
options Object <optional>
 { }

An object containing options for the TK.Container to be added as page if content is either a string or a DOMNode.
position integer | undefined

The position to add the new page to. If undefined, the page is added at the end.
Source:
Fires:

add_pages(options)

Adds an array of pages.

Parameters:
Name Type Description
options Array.<Object>

An Array of objects with members label and content. label is a string with the TK.Buttons label or an object containing options for the TK.Button instance. content is either a TK.Container (or derivate) widget, a DOMNode (needs option options to be set) or a string which gets wrapped in a new TK.Container with options from argument options.
Source:
Example
var p = new TK.Pager();
p.add_pages([
  {
    label: "Page 1",
    content: "<h1>Page1</h1>",
  }
]);

current()

Returns the currently displayed page or null.

Source:

first()

Opens the first page of the pager. Returns true if a first page exists, false otherwise.

Source:

last()

Opens the last page of the pager. Returns true if a last page exists, false otherwise.

Source:

next()

Opens the next page of the pager. Returns true if a next page exists, false otherwise.

Source:

prev()

Opens the previous page of the pager. Returns true if a previous page exists, false otherwise.

Source:

remove_page(page)

Removes a page from the TK.Pager.

Parameters:
Name Type Description
page integer | TK.Container

The container to remove. Either a position or the TK.Container widget generated by add_page.
Source:
Fires:

Methods inherited from TK.Container

append_child(child)

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

append_children(children)

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

force_hide()

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.

force_show()

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.

hide()

Starts the transition of the display_state to hide.

hide_child(child)

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

show()

Starts the transition of the display_state to show.

show_child(child)

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

toggle_child(child)

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

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.

get_style()

Returns the computed style of this widgets DOM element.

hidden()

Returns the current hidden status.

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.

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

added

A page was added to the TK.Pager.

Parameters:
Name Type Description
page TK.Container

The TK.Container which was added as a page.
Source:

changed

The page to show has changed.

Parameters:
Name Type Description
page TK.Container

The TK.Container instance of the newly selected page.
id number

The ID of the page.
Source:

removed

A page was removed from the Pager

Parameters:
Name Type Description
page TK.Container

The TK.Container which was removed.
Source:

useraction

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

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:

Events inherited from TK.Container

hide

Is fired when the container is hidden.

show

Is fired when the container is shown.

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.

doubleclick

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

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.

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.