Class Index | File Index

Classes


Class sWindow


Defined in: <./sWindow.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Front-end to window object properties such as height.
Method Summary
Method Attributes Method Name and Description
 
addEvent(type, func, useCapture)
Alias to addEventListener for window.
 
addEventListener(type, func, useCapture)
Add an event listener to the window object.
 
bind(type, func, useCapture)
Alias to addEventListener for window.
 
Gets the height of the window.
 
Gets the width of the window.
Class Detail
sWindow()
Front-end to window object properties such as height.
Method Detail
{sWindow} addEvent(type, func, useCapture)
Alias to addEventListener for window.
Parameters:
{string} type
Type of event.
{(EventListener|function((sEvent|Event|null)):(boolean|undefined)|null)} func
Callback.
{boolean} useCapture Optional
Not used.
Returns:
{sWindow} The object to allow method chaining.

{sWindow} addEventListener(type, func, useCapture)
Add an event listener to the window object.
Parameters:
{string} type
Type of event.
{(EventListener|function((sEvent|Event|null)):(boolean|undefined)|null)} func
Callback.
{boolean} useCapture Optional, Default: false
If the user is to initiate the event.
Returns:
{sWindow} The object to allow method chaining.

{sWindow} bind(type, func, useCapture)
Alias to addEventListener for window.
Parameters:
{string} type
Type of event.
{(EventListener|function((sEvent|Event|null)):(boolean|undefined)|null)} func
Callback.
{boolean} useCapture Optional
Not used.
Returns:
{sWindow} The object to allow method chaining.

{number} getHeight()
Gets the height of the window.
Returns:
{number} Height of the window.

{number} getWidth()
Gets the width of the window.
Returns:
{number} Width of the window.

Documentation generated by JsDoc Toolkit 2.4.0 on Sat Mar 31 2012 06:13:49 GMT-0500 (CDT)