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

public class | source

Window

Extends:

@osjs/event-emitter~EventEmitter → Window

Window Implementation

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: WindowOptions) 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	inited: boolean The window was inited
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	_lastAttributes: WindowAttributes Last DOM update data attributes
private	_lastCssText: string Last DOM update CSS text
private	_loadingDebounce: boolean Internal timeout reference used for triggering the loading overlay.
private	_ondestroy: Function Custom destructor callback
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(): WindowSession 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(): boolean 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, updateAll: boolean) Internal method for setting state
private	_toggleState(name: string, value: any, eventName: string, update: boolean): boolean Internal method for toggling state
private	_updateAttributes() Updates window data in DOM
private	_updateButtons() Updates the window buttons in DOM
private	_updateHeaderStyles() Updates window header decoration in DOM
private	_updateIconStyles() Updates window icon decoration in DOM
private	_updateStyles() Updates window style in DOM
private	_updateTitle() Updates window title in 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: WindowOptions) source

Create window

Params:

Name	Type	Attribute	Description
core	Core		Core reference
options	WindowOptions	optional default: {}	Options

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 inited: boolean source

The window was inited

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 _lastAttributes: WindowAttributes source

Last DOM update data attributes

private _lastCssText: string source

Last DOM update CSS text

private _loadingDebounce: boolean source

Internal timeout reference used for triggering the loading overlay.

private _ondestroy: Function source

Custom destructor callback

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(): WindowSession source

Get a snapshot of the Window session

Return:

WindowSession

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(): boolean source

Check if we have to set next zindex

Return:

boolean

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, updateAll: 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
updateAll	boolean	optional default: true	Update the entire 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 _updateAttributes() source

Updates window data in DOM

private _updateButtons() source

Updates the window buttons in DOM

private _updateHeaderStyles() source

Updates window header decoration in DOM

private _updateIconStyles() source

Updates window icon decoration in DOM

private _updateStyles() source

Updates window style in DOM

private _updateTitle() source

Updates window title in 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: WindowOptions) 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 inited: boolean source

public parent: Window source

public rendered: boolean source

public state: WindowState source

public wid: Number source

Private Members

private _lastAttributes: WindowAttributes source

private _lastCssText: string source

private _loadingDebounce: boolean source

private _ondestroy: Function 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(): WindowSession 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 getState(n: ): source