Class SS.control.window

Moveable Window - Includes modal option
Defined in: SS.control.window.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SS.control.window()

Field Summary
Field Attributes	Field Name and Description
<private>	_ib Titlebar Id
<private>	_ig Background Id
<private>	_in Container Id
	background Flag to indicate whether or not a background with a semi-transparent colour that covers the screen should be used.
	bgopacity Opacity of the background blanket (if enabled).
	button_close Flag to indicate if there should be a close button in the title bar.
	button_max Flag to indicate if there should be a maximize button in the title bar.
	css Style sheet class applied to the window.
	css_title Style sheet class applied to the title.
	height Height of the window in any supported size unit.
	id Identifier of the window control.
	onclose Function called or evaluated {String} whenever the window has been closed.
	onhide Function called or evaluated {String} whenever the window has been made invisible (hidden).
	onresize Function called or evaluated {String} whenever the window is resized.
	onshow Function called or evaluated {String} whenever the window has been made visible.
	resize Flag to indicate whether or not the window can be resized by using the resize pick in the bottom right of the window.
	title Title text to appear in the title bar.
	titlebar Flag to indicate if the window should have a title bar.
	visible Flag to indicate whether or not the window is currently visible.
	width Width of the window in any supported size unit.

Method Summary
Method Attributes	Method Name and Description
	destroy() Destroy the window, releasing any elements used.
	display(v, e) Set the visibility of the window.
	hide(e) Make the window invisible but without destroying it.
	render() Renders the window on the page.
	show(e) Make the window visible.
	size(w, h) Set the window height and width.

Class Detail

SS.control.window()

Field Detail

<private> _ib

Titlebar Id

<private> _ig

Background Id

<private> _in

Container Id

background

Flag to indicate whether or not a background with a semi-transparent colour that covers the screen should be used. Default = true.

bgopacity

Opacity of the background blanket (if enabled). Valid values range from 0 (invisible) to 100 (opaque). Default = 50.

button_close

Flag to indicate if there should be a close button in the title bar. Default = true.

button_max

Flag to indicate if there should be a maximize button in the title bar. Default = false.

css

Style sheet class applied to the window. Default = ""

css_title

Style sheet class applied to the title. Default = ""

height

Height of the window in any supported size unit. E.g. px or % Default = ""

Identifier of the window control.

onclose

Function called or evaluated {String} whenever the window has been closed.

onhide

Function called or evaluated {String} whenever the window has been made invisible (hidden).

onresize

Function called or evaluated {String} whenever the window is resized.

onshow

Function called or evaluated {String} whenever the window has been made visible.

resize

Flag to indicate whether or not the window can be resized by using the resize pick in the bottom right of the window. Default = false.

title

Title text to appear in the title bar. Default = ""

titlebar

Flag to indicate if the window should have a title bar. Default = true.

visible

Flag to indicate whether or not the window is currently visible. Overrides style="display:none;" rule on initial render. Default = true.

width

Width of the window in any supported size unit. E.g. px or % Default = ""

Method Detail

destroy()

Destroy the window, releasing any elements used. This window cannot be made visible again.

display(v, e)

Set the visibility of the window.

Parameters:
{Boolean} v: Visible flag. true to make visible, false to hide.
{Event} e: Event

hide(e)

Make the window invisible but without destroying it.

Parameters:
{Event} e: Event

render()

Renders the window on the page.

Returns:: null

show(e)

Make the window visible.

Parameters:
{Event} e: Event

size(w, h)

Set the window height and width.

Parameters:
{String} w: Width. Width of the window. E.g. 100, 100px, 100%
{String} h: Height. Height of the window. E.g. 100, 100px, 100%

Classes

Classes

Class SS.control.window