Window

Window

new Window(optionsopt)

Source:
Mixes In:
Properties:
Name Type Attributes Default Description
options.width Number <optional>
500

Initial width, can be a CSS length or an integer (pixels).

options.height Number <optional>
200

Initial height, can be a CSS length or an integer (pixels).

options.x Number <optional>
0

X position of the window.

options.y Number <optional>
0

Y position of the window.

options.min_width Number <optional>
64

Minimum width of the window.

options.max_width Number <optional>
-1

Maximum width of the window, -1 ~ infinite.

options.min_height Number <optional>
64

Minimum height of the window.

options.max_height Number <optional>
-1

Maximum height of the window, -1 ~ infinite.

options.anchor String <optional>
"top-left"

Anchor of the window, can be one out of top-left, top, top-right, left, center, right, bottom-left, bottom, bottom-right

options.modal Boolean <optional>
false

If modal window blocks all other elements

options.dock String <optional>
false

Docking of the window, can be one out of top-left, top, top-right, left, center, right, bottom-left, bottom, bottom-right

options.maximize Object | Boolean <optional>
false

Boolean or object with members x and y as boolean to determine the maximized state.

options.minimize Boolean <optional>
false

Minimize window (does only make sense with a window manager application to keep track of it)

options.shrink Boolean <optional>
false

Shrink rolls the window up into the title bar.

options.content String | HTMLElement | Container <optional>
""

The content of the window. Can be either a string, a HTMLElement or a Container to append to the content area.

options.open String <optional>
"center"

initial position of the window, can be one out of top-left, top, top-right, left, center, right, bottom-left, bottom, bottom-right

options.z_index Integer <optional>
10000

Z index for piling windows. does make more sense when used together with a window manager

options.header String | Array.<String> <optional>
["title", "maximize", "close"]

Single element or array of title, icon, close, minimize, shrink, maximize, maximizevertical, maximizehorizontal, status, resize, spacer.

options.footer String | Array.<String> <optional>
false

Single element or array of title, icon, close, minimize, shrink, maximize, maximizevertical, maximizehorizontal, status, resize, spacer.

options.title String <optional>
false

Window title.

options.status String <optional>
false

Window status.

options.icon String <optional>
false

URL to window icon.

options.fixed Boolean <optional>
true

Whether the window sticks to the viewport rather than the document

options.auto_active Boolean <optional>
false

Auto-toggle the active-class when mouseovered

options.auto_close Boolean <optional>
true

Set whether close destroys the window or not

options.auto_maximize Boolean <optional>
true

Set whether maximize toggles the window or not

options.auto_minimize Boolean <optional>
true

Set whether minimize toggles the window or not

options.auto_shrink Boolean <optional>
true

Set whether shrink toggles the window or not

options.draggable Boolean <optional>
true

Set whether the window is draggable

options.resizable Boolean <optional>
true

Set whether the window is resizable

options.resizing String <optional>
"continuous"

Resizing policy, continuous or stop. The first one resizes all children continuously while resizing.

options.header_action String <optional>
"maximize"

Action for double clicking the window header, one out of close, minimize, shrink, maximize, maximizevertical, maximizehorizontal

options.active Boolean <optional>
true

Active state of the window.

options.hide_status Integer <optional>
0

If set to !0 status message hides after [n] milliseconds.

options.hiding_duration Number <optional>
0

The duration in ms of the hiding CSS transition/animation of this container. If this option is set to -1, the transition duration will be determined by the computed style, which can be rather expensive. Setting this option explicitly can therefore be an optimization. (Defined in Container)

options.showing_duration Number <optional>
0

The duration in ms of the showing CSS transition/animation of this container. If this option is set to -1, the transition duration will be determined by the computed style, which can be rather expensive. Setting this option explicitly can therefore be an optimization. (Defined in Container)

options.disabled Boolean <optional>
false

Toggles the class .aux-disabled. By default it disables all pointer events on the widget via CSS to make it unusable to the user. (Defined in Widget)

options.visible Boolean <optional>

Toggles the class .aux-hide and .aux-show. This option also enables and disabled rendering by calling Widget#hide and Widget#show. (Defined in Widget)

options.needs_resize Boolean <optional>
true

Set to true if the resize function shall be called before the next redraw. (Defined in Widget)

options.dblclick Boolean <optional>
400

Set a time in milliseconds for triggering double click event. If 0, no double click events are fired. (Defined in Widget)

options.preset String <optional>

Set a preset. This string gets set as class attribute aux-preset-[preset]. If options.presets has a member of this name, all options of its option object are set on the Widget. Non-existent options are reset to the default. Defaults are updated on initialization and runtime. (Defined in Widget)

options.presets Object <optional>
{}

An object with available preset specific options. Refer to options.preset for more information. (Defined in Widget)

This widget is a flexible overlay window.

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

An object containing initial options.

Extends

Members

close :Button

Source:

The close button.

Type:

content :Container

Source:

A Container for the window content.

Type:

drag :Drag

Source:

The Drag module.

Type:

element :HTMLDivElement

Source:
Inherited From:

The main DIV element. Has class .aux-container

Type:
  • HTMLDivElement
Source:

The bottom footer bar.

Type:
Source:

The top header bar.

Type:

icon :Icon

Source:

A Icon widget to display the window icon.

Type:

maximize :Button

Source:

The maximize button.

Type:

maximizehorizontal :Button

Source:

The maximizehorizontal button.

Type:

maximizevertical :Button

Source:

The maximizevertical button.

Type:

minimize :Button

Source:

The minimize button.

Type:

resize :Resize

Source:

The Resize module.

Type:

shrink :Button

Source:

The shrink button.

Type:

size :Icon

Source:

A Icon acting as handle for window resize.

Type:

status :Label

Source:

A Label to display the window status.

Type:

title :Label

Source:

A Label to display the window title.

Type:

Methods

add_child(child)

Source:
Inherited From:
See:

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

Parameters:
Name Type Description
child Widget

The child to add.

Fires:
  • Widget#event:child_added

add_children(a)

Source:
Inherited From:

Registers an array of widgets as children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

addEventListener(event, func)

Source:
Inherited From:

Register an event handler.

Parameters:
Name Type Description
event string

The event descriptor.

func function

The function to call when the event happens.

all_children()

Source:
Inherited From:

Returns an array of all children.

append_child(child)

Source:
Overrides:

Appends a new child to the window content area.

Parameters:
Name Type Description
child Widget

The child widget to add to the windows content area.

append_children(children)

Source:
Inherited From:

Calls Widget#append_child for an array of widgets.

Parameters:
Name Type Description
children Array.<Widget>

The child widgets to append.

delegate_events(element) → {HTMLElement}

Source:
Inherited From:

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.

Parameters:
Name Type Description
element HTMLElement

The element all native events of the widget should be bound to.

Fires:
Returns:

The element

Type
HTMLElement

destroy()

Source:
Inherited From:

Destroys all event handlers and the options object.

dispatchEvent(event, …args)

Source:
Inherited From:

Fires an event.

Parameters:
Name Type Attributes Description
event string

The event descriptor.

args * <repeatable>

Event arguments.

enable_draw()

Source:
Inherited From:

Schedules this widget for drawing.

Fires:

enable_draw_children()

Source:
Inherited From:

Enables rendering for all children of this widget.

force_hide()

Source:
Inherited From:

Hide the widget immediately by applying the class aux-hide. Does not call disable_draw().

force_show()

Source:
Inherited From:

Show the widget immediately by applying the class aux-show. Does not call enable_draw().

get(key)

Source:
Inherited From:

Get the value of an option.

Parameters:
Name Type Description
key string

The option name.

get_default()

Source:
Inherited From:

Returns the default value of a given option. If the option does not exist, an exception is thrown.

get_option_type()

Source:
Inherited From:

Returns the type of an option. If the given option does not exist, 'undefined' is returned.

get_style()

Source:
Inherited From:

Returns the computed style of this widget's DOM element.

has_event_listeners(event) → {boolean}

Source:
Inherited From:

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

Parameters:
Name Type Description
event string

The event desriptor.

Returns:

True if the event has some handler functions in the queue, false if not.

Type
boolean

hidden()

Source:
Inherited From:

Returns the current hidden status.

hide()

Source:
Inherited From:

Starts the transition of the visible to false.

hide_child(child)

Source:
Inherited From:

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

Parameters:
Name Type Description
child Object | integer

Child or its index.

off(event, fun)

Source:
Inherited From:

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

Parameters:
Name Type Description
event string

The event descriptor.

fun function

The function to remove.

remove_child(child)

Source:
Inherited From:

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

Parameters:
Name Type Description
child Widget

The child to remove.

Fires:
  • Widget#event:child_removed

remove_children(a)

Source:
Inherited From:

Removes an array of children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

reset(key)

Source:
Inherited From:

Resets an option to its default value.

Parameters:
Name Type Description
key string

The option name.

set(key, value)

Source:
Inherited From:

Sets an option.

Parameters:
Name Type Description
key string

The option name.

value

The option value.

set_options(optionsopt)

Source:
Inherited From:

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 an event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.

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

An object containing initial options.

set_style()

Source:
Inherited From:

Sets a CSS style property in this widget's DOM element.

show()

Source:
Inherited From:

Starts the transition of the visible to true.

show_child(child)

Source:
Inherited From:

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

Parameters:
Name Type Description
child Object | integer

Child or its index.

toggle_child(child)

Source:
Inherited From:

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

Parameters:
Name Type Description
child Object | integer

Child or its index.

toggle_hidden()

Source:
Inherited From:

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

toggle_maximize(maximize)

Source:

Toggles the overall maximize state of the window.

Parameters:
Name Type Description
maximize Boolean

State of maximization. If window is already maximized in one or both directions it is un-maximized, otherwise maximized.

toggle_maximize_horizontal(maximize)

Source:

Toggles the horizontal maximize state of the window.

Parameters:
Name Type Description
maximize Boolean

The new horizontal maximization.

toggle_maximize_vertical(maximize)

Source:

Toggles the vertical maximize state of the window.

Parameters:
Name Type Description
maximize Boolean

The new vertical maximization.

toggle_minimize(minimize)

Source:

Toggles the minimize state of the window.

Parameters:
Name Type Description
minimize Boolean

The new minimization.

toggle_shrink(shrink)

Source:

Toggles the shrink state of the window.

Parameters:
Name Type Description
shrink Boolean

The new shrink state.

update(key, value)

Source:
Inherited From:

Conditionally sets an option unless it already has the requested value.

Parameters:
Name Type Description
key string

The name of the option.

value mixed

The value of the option.

Fires:

userset(key, value)

Source:
Inherited From:

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.

Parameters:
Name Type Description
key string

The name of the option.

value mixed

The value of the option.

Fires:
  • Base#event:userset
  • Base#event:useraction

visible_children()

Source:
Inherited From:

Returns an array of all visible children.

Events

closeclicked

Source:

The user clicked the close button.

dimensionschanged

Source:

The dimensions of the window changed.

Parameters:
Name Type Description
event Object

The Window#dimensions dimensions object.

dragging

Source:

The user is dragging the window.

Parameters:
Name Type Description
event DOMEvent

The DOM event.

footerchanged

Source:

The footer changed.

headeraction

Source:

The user double-clicked on the header.

Parameters:
Name Type Description
action string

The function which was executed, e.g. shrink, maximize or close.

headerchanged

Source:

The header changed.

maximizeclicked

Source:

The user clicked the maximize button.

Parameters:
Name Type Description
maximize Object

The maximize option.

maximizehorizontalclicked

Source:

The user clicked the maximize-horizontal button.

Parameters:
Name Type Description
maximize Object

The maximize option.

maximizeverticalclicked

Source:

The user clicked the maximize-vertical button.

Parameters:
Name Type Description
maximize Object

The maximize option.

minimizeclicked

Source:

The user clicked the minimize button.

Parameters:
Name Type Description
minimize Object

The minimize option.

positionchanged

Source:

The position of the window changed.

Parameters:
Name Type Description
event Object

The Window#dimensions dimensions object.

resizing

Source:

The user resizes the window.

Parameters:
Name Type Description
event DOMEvent

The DOM event.

shrinkclicked

Source:

The user clicked the shrink button.

Parameters:
Name Type Description
shrink Object

The shrink option.

startdrag

Source:

The user starts dragging the window.

Parameters:
Name Type Description
event DOMEvent

The DOM event.

startresize

Source:

The user starts resizing the window.

Parameters:
Name Type Description
event DOMEvent

The DOM event.

stopdrag

Source:

The user stops dragging the window.

Parameters:
Name Type Description
event DOMEvent

The DOM event.

stopresize

Source:

The user stops resizing the window.

Parameters:
Name Type Description
event DOMEvent

The DOM event.

delegated

Source:
Inherited From:

Is fired when an element is delegated.

Parameters:
Name Type Description
element HTMLElement | Array

The element which receives all native DOM events.

old_element HTMLElement | Array

The element which previously received all native DOM events.

destroy

Source:
Inherited From:

Is fired when a widget is destroyed.

doubleclick

Source:
Inherited From:

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

Parameters:
Name Type Description
event string

The browsers MouseEvent.

GenericDOMEvents

Source:
Inherited From:

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

hide

Source:
Inherited From:

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 Pager.

initialized

Source:
Inherited From:

Is fired when a widget is initialized.

redraw

Source:
Inherited From:

The redraw event is emitted when a widget is redrawn. This can be used to do additional DOM modifications to a Widget.

resize

Source:
Inherited From:

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 Widget#resized event can be used instead.

resized

Source:
Inherited From:

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

set

Source:
Inherited From:

The set event is emitted when an option was set using the 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.

set_[option]

Source:
Inherited From:

Is fired when an option is set.

Parameters:
Name Type Description
value mixed

The value of the option.

show

Source:
Inherited From:

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

visibility

Source:
Inherited From:

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