import Window from '@osjs/client/src/window.js'

public class | source

Window

Extends:

@osjs/event-emitter~EventEmitter → Window

Class for a OS.js Window

Static Method Summary

Static Public Methods
public static	getWindows(): Window[] Get a list of all windows
public static	lastWindow(): Window Gets the lastly focused Window

Constructor Summary

Public Constructor
public	constructor(core: Core, options: object) Create window

Member Summary

Public Members
public	$content: Element The content container
public	$element: Element The window container
public	$header: Element The header container
public	$icon: Element The icon container
public	$title: Element The title container
public	attributes: WindowAttributes The window attributes
public	children: Window[] Child windows (via 'parent')
public	core: Core Core instance reference
public	destroyed: boolean The window destruction state
public	id: string The Window ID
public	parent: Window Parent Window reference
public	rendered: boolean The window rendered state
public	state: WindowState The window state
public	wid: Number The Window ID

Private Members
private	_loadingDebounce: boolean Internal timeout reference used for triggering the loading overlay.
private	_preventDefaultPosition: boolean Internal variable to signal not to use default position given by user (used for restore)
private	_template: string \| Function The window template

Method Summary

Public Methods
public	blur(): boolean Blur (un-focus) the window
public	clampToViewport(update: boolean) Clamps the position to viewport
public	close(): boolean Close the window
public	destroy() Destroy window
public	focus(): boolean Focus the window
public	getSession(): Object Get a snapshot of the Window session
public	getState(n: ): Gets a astate
public	gravitate(gravity: string) Gravitates window towards a certain area
public	init(): * Initialize window
public	maximize(): boolean Maximize the window
public	minimize(): boolean Minimize (hide) the window
public	raise(): boolean Raise (un-minimize) the window
public	render(callback: Function): Window Render window
public	resizeFit(container: Element) Resize to fit to current container
public	restore(): boolean Restore (un-maximize) the window
public	setDimension(dimension: WindowDimension) Set the Window dimension
public	setIcon(uri: string) Set the Window icon
public	setNextZindex(force: boolean) Sets the Window to next z index
public	setPosition(position: WindowPosition, preventDefault: boolean) Set the Window position
public	setState(name: string, value: *, update: boolean) Set a state by value
public	setTitle(title: string) Set the Window title
public	setZindex(zIndex: Number) Set the Window z index

Private Methods
private	_checkModal() Checks the modal state of the window upon render
private	_checkNextZindex(): * Check if we have to set next zindex
private	_focus() Internal for focus
private	_initBehavior() Initializes window behavior
private	_initTemplate() Initializes window template
private	_maximize(toggle: boolean): boolean Internal for Maximize or restore
private	_setClassNames() Sets the initial class names
private	_setState(name: string, value: *, update: boolean) Internal method for setting state
private	_toggleState(name: string, value: any, eventName: string, update: boolean): boolean Internal method for toggling state
private	_updateButtons() Updates the window buttons
private	_updateDOM() Updated the Window DOM

Static Public Methods

public static getWindows(): Window[] source

Get a list of all windows

Return:

Window[]

public static lastWindow(): Window source

Gets the lastly focused Window

Return:

Window

Public Constructors

public constructor(core: Core, options: object) source

Create window

Params:

Name	Type	Attribute	Description
core	Core		Core reference
options	object		Options
options.id	string		Window Id (not globaly unique)
options.title	string	optional	Window Title
options.icon	string	optional	Window Icon
options.parent	Window	optional	The parent Window reference
options.template	string \| Function	optional	The Window HTML template (or function with signature (el, win) for programatic construction)
options.position	WindowPosition \| string	optional	Window position
options.dimension	WindowDimension	optional	Window dimension
options.attributes	WindowAttributes	optional	Apply Window attributes
options.state	WindowState	optional	Apply Window state

Public Members

public $content: Element source

The content container

public $element: Element source

The window container

The header container

public $icon: Element source

The icon container

public $title: Element source

The title container

public attributes: WindowAttributes source

The window attributes

public children: Window[] source

Child windows (via 'parent')

public core: Core source

Core instance reference

public destroyed: boolean source

The window destruction state

public id: string source

The Window ID

public parent: Window source

Parent Window reference

public rendered: boolean source

The window rendered state

public state: WindowState source

The window state

public wid: Number source

The Window ID

Private Members

private _loadingDebounce: boolean source

Internal timeout reference used for triggering the loading overlay.

private _preventDefaultPosition: boolean source

Internal variable to signal not to use default position given by user (used for restore)

private _template: string | Function source

The window template

Public Methods

public blur(): boolean source

Blur (un-focus) the window

Return:

boolean

public clampToViewport(update: boolean) source

Clamps the position to viewport

Params:

Name	Type	Attribute	Description
update	boolean	optional default: true	Update DOM

public close(): boolean source

Close the window

Return:

boolean

public destroy() source

Destroy window

public focus(): boolean source

Focus the window

Return:

boolean

public getSession(): Object source

Get a snapshot of the Window session

Return:

Object

public getState(n: ): source

Gets a astate

Params:

Name	Type	Attribute	Description
n	*

Return:

public gravitate(gravity: string) source

Gravitates window towards a certain area

Params:

Name	Type	Attribute	Description
gravity	string		Gravity

public init(): * source

Initialize window

Return:

public maximize(): boolean source

Maximize the window

Return:

boolean

public minimize(): boolean source

Minimize (hide) the window

Return:

boolean

public raise(): boolean source

Raise (un-minimize) the window

Return:

boolean

public render(callback: Function): Window source

Render window

Params:

Name	Type	Attribute	Description
callback	Function	optional	Callback when window DOM has been constructed

Return:

Window

this instance

public resizeFit(container: Element) source

Resize to fit to current container

Params:

Name	Type	Attribute	Description
container	Element	optional	The DOM element to use

public restore(): boolean source

Restore (un-maximize) the window

Return:

boolean

public setDimension(dimension: WindowDimension) source

Set the Window dimension

Params:

Name	Type	Attribute	Description
dimension	WindowDimension		The dimension

public setIcon(uri: string) source

Set the Window icon

Params:

Name	Type	Attribute	Description
uri	string		Icon URI

public setNextZindex(force: boolean) source

Sets the Window to next z index

Params:

Name	Type	Attribute	Description
force	boolean	optional	Force next index

public setPosition(position: WindowPosition, preventDefault: boolean) source

Set the Window position

Params:

Name	Type	Attribute	Description
position	WindowPosition		The position
preventDefault	boolean	optional default: false	Prevents any future position setting in init procedure

public setState(name: string, value: *, update: boolean) source

Set a state by value

Params:

Name	Type	Attribute	Description
name	string		State name
value	*		State value
update	boolean	optional default: true	Update the DOM

See:

{WindowState}

public setTitle(title: string) source

Set the Window title

Params:

Name	Type	Attribute	Description
title	string		Title

public setZindex(zIndex: Number) source

Set the Window z index

Params:

Name	Type	Attribute	Description
zIndex	Number		the index

Private Methods

private _checkModal() source

Checks the modal state of the window upon render

private _checkNextZindex(): * source

Check if we have to set next zindex

Return:

private _focus() source

Internal for focus

private _initBehavior() source

Initializes window behavior

private _initTemplate() source

Initializes window template

private _maximize(toggle: boolean): boolean source

Internal for Maximize or restore

Params:

Name	Type	Attribute	Description
toggle	boolean		Maximize or restore

Return:

boolean

private _setClassNames() source

Sets the initial class names

private _setState(name: string, value: *, update: boolean) source

Internal method for setting state

Params:

Name	Type	Attribute	Description
name	string		State name
value	*		State value
update	boolean	optional default: true	Update the DOM

private _toggleState(name: string, value: any, eventName: string, update: boolean): boolean source

Internal method for toggling state

Params:

Name	Type	Attribute	Description
name	string		State name
value	any		State value
eventName	string		Name of event to emit
update	boolean	optional default: true	Update the DOM

Return:

boolean

private _updateButtons() source

Updates the window buttons

private _updateDOM() source

Updated the Window DOM

Window

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static getWindows(): Window[] source

Return:

public static lastWindow(): Window source

Return:

Public Constructors

public constructor(core: Core, options: object) source

Params:

Public Members

public $content: Element source

public $element: Element source

public $header: Element source

public $icon: Element source

public $title: Element source

public attributes: WindowAttributes source

public children: Window[] source

public core: Core source

public destroyed: boolean source

public id: string source

public parent: Window source

public rendered: boolean source

public state: WindowState source

public wid: Number source

Private Members

private _loadingDebounce: boolean source

private _preventDefaultPosition: boolean source

private _template: string | Function source

Public Methods

public blur(): boolean source

Return:

public clampToViewport(update: boolean) source

Params:

public close(): boolean source

Return:

public destroy() source

public focus(): boolean source

Return:

public getSession(): Object source

Return:

public getState(n: *): * source

Params:

Return:

public gravitate(gravity: string) source

Params:

public init(): * source

Return:

public maximize(): boolean source

Return:

public minimize(): boolean source

Return:

public raise(): boolean source

Return:

public render(callback: Function): Window source

Params:

Return:

public resizeFit(container: Element) source

Params:

public restore(): boolean source

Return:

public setDimension(dimension: WindowDimension) source

Params:

public setIcon(uri: string) source

Params:

public setNextZindex(force: boolean) source

Params:

public setPosition(position: WindowPosition, preventDefault: boolean) source

Params:

public setState(name: string, value: *, update: boolean) source

Params:

See:

public setTitle(title: string) source

Params:

public setZindex(zIndex: Number) source

Params:

public getState(n: ): source