diff --git a/docs/files.html b/docs/files.html index 5331e92..81dfe27 100644 --- a/docs/files.html +++ b/docs/files.html @@ -1,142 +1 @@ - - - - - - JsDoc Reference - File Index - - - - - - - - -
-
-
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- -
- Kis JS Docs -
- - -
- -

File Index

- -
-
- -
- core.js ../kis-js/src/modules/event.js - -
- - -
-
- -
- ajax.js ../kis-js/src/modules/event.js - -
- - -
-
- -
- DOM.js ../kis-js/src/modules/event.js - -
- - -
-
- -
- event.js ../kis-js/src/modules/event.js - -
- - -
-
- -
- store.js ../kis-js/src/modules/event.js - -
- - -
-
- -
- util.js ../kis-js/src/modules/event.js - -
- - -
-
- -
-
- -
- -
- ©2011
- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
-
-
- - - +JsDoc Reference - File Index
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

File Index

core.js../kis-js/src/modules/event.js
ajax.js../kis-js/src/modules/event.js
DOM.js../kis-js/src/modules/event.js
event.js../kis-js/src/modules/event.js
store.js../kis-js/src/modules/event.js
util.js../kis-js/src/modules/event.js
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index c9d9319..d9dfc43 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,156 +1 @@ - - - - - - JsDoc Reference - Index - - - - - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- -
- Kis JS Docs -
- - -
- -

Class Index

- -
-
- -
- - -
- -
- - -
- -
- - -
- -
- - -
- -
- - -
- -
- - - _global_ -
-

- Global namespace. -

-
- -
- -
-
- -
-
- ©2011
- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
-
-
- - - +JsDoc Reference - Index
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Class Index

_global_

Global namespace.

\ No newline at end of file diff --git a/docs/symbols/$_.dom.html b/docs/symbols/$_.dom.html index 7ae6912..ea57490 100644 --- a/docs/symbols/$_.dom.html +++ b/docs/symbols/$_.dom.html @@ -1,634 +1 @@ - - - - - - - JsDoc Reference - $_.dom - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- - - -
- Kis JS Docs -
- - - -
- -

- Namespace $_.dom -

- - - -
-

-
- -

Defined in: DOM.js.

- - - - - - - - - - - - -
-
Method Summary
-
- -
- - addClass(string) - Adds a class to the element(s) specified by the current selector -
- -
- - removeClass(string) - Removes a class from the element(s) specified by the current selector -
- -
- - hide() - Hides the element(s) specified by the current selector -
- -
- - show(string) - Shows the element(s) specified by the current selector. -
- -
- - attr(string, string) - Sets attributes on element(s) specified by the current selector, or, if name is not specified, returns the value of the attribute of the element specified by the current selector. -
- -
- - text(string) - Sets or retrieves the text content of the element specified by the current selector. -
- -
- - css(string, string) - Sets or retrieves a css property of the element specified by the current selector. -
- -
- - html(string) - Sets or gets the innerHTML propery of the element(s) passed -
- -
-
- - - - - - - - - - - -
-
- Method Detail -
-
- - -
- -
- $_.dom.addClass(string) - -
-
- Adds a class to the element(s) specified by the current -selector - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - string - - class -
- - - - - - - - -
- - -
- -
- $_.dom.removeClass(string) - -
-
- Removes a class from the element(s) specified by the current -selector - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - string - - class -
- - - - - - - - -
- - -
- -
- $_.dom.hide() - -
-
- Hides the element(s) specified by the current selector - - - - -

-										
-									
- - - - - - - - - -
- - -
- -
- $_.dom.show(string) - -
-
- Shows the element(s) specified by the current selector. -if type is specified, the element will have it's style -property set to "display:[your type]". If type is not -specified, the element is set to "display:block". - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - string?, Default: - - type -
- - - - - - - - -
- - -
- -
- $_.dom.attr(string, string) - : string -
-
- Sets attributes on element(s) specified by the current -selector, or, if name is not specified, returns the -value of the attribute of the element specified by the -current selector. - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - name -
- - - string?, Default: - - value -
- - - - - -
Returns:
- - - - - - - -
- - - string -
- - - - -
- - -
- -
- $_.dom.text(string) - : string -
-
- Sets or retrieves the text content of the element -specified by the current selector. If a value is -passed, it will set that value on the current element, -otherwise it will return the value of the current element - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - string?, Default: - - value -
- - - - - -
Returns:
- - - - - - - -
- - - string -
- - - - -
- - -
- -
- $_.dom.css(string, string) - : string -
-
- Sets or retrieves a css property of the element -specified by the current selector. If a value is -passed, it will set that value on the current element, -otherwise it will return the value of the css property -on the current element - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - property -
- - - string?, Default: - - value -
- - - - - -
Returns:
- - - - - - - -
- - - string -
- - - - -
- - -
- -
- $_.dom.html(string) - : string -
-
- Sets or gets the innerHTML propery of the element(s) passed - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - string?, Default: - - htm -
- - - - - -
Returns:
- - - - - - - -
- - - string -
- - - - -
- -
-
- - -
- - -
- ©2011

- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
- -
-
- - - +JsDoc Reference - $_.dom
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Module $_.dom

Defined in: DOM.js.

Method Summary
addClass(string)Adds a class to the element(s) specified by the current selector
removeClass(string)Removes a class from the element(s) specified by the current selector
hide()Hides the element(s) specified by the current selector
show(string)Shows the element(s) specified by the current selector.
attr(string, string)Sets attributes on element(s) specified by the current selector, or, if name is not specified, returns the value of the attribute of the element specified by the current selector.
text(string)Sets or retrieves the text content of the element specified by the current selector.
css(string, string)Sets or retrieves a css property of the element specified by the current selector.
html(string)Sets or gets the innerHTML propery of the element(s) passed
Method Detail
$_.dom.addClass(string)
Adds a class to the element(s) specified by the current selector
Parameters:
string class
$_.dom.removeClass(string)
Removes a class from the element(s) specified by the current selector
Parameters:
string class
$_.dom.hide()
Hides the element(s) specified by the current selector
$_.dom.show(string)
Shows the element(s) specified by the current selector. if type is specified, the element will have it's style property set to "display:[your type]". If type is not specified, the element is set to "display:block".
Parameters:
string?, Default: type
$_.dom.attr(string, string): string
Sets attributes on element(s) specified by the current selector, or, if name is not specified, returns the value of the attribute of the element specified by the current selector.
Parameters:
string name
string?, Default: value
Returns:
string
$_.dom.text(string): string
Sets or retrieves the text content of the element specified by the current selector. If a value is passed, it will set that value on the current element, otherwise it will return the value of the current element
Parameters:
string?, Default: value
Returns:
string
$_.dom.css(string, string): string
Sets or retrieves a css property of the element specified by the current selector. If a value is passed, it will set that value on the current element, otherwise it will return the value of the css property on the current element
Parameters:
string property
string?, Default: value
Returns:
string
$_.dom.html(string): string
Sets or gets the innerHTML propery of the element(s) passed
Parameters:
string?, Default: htm
Returns:
string
\ No newline at end of file diff --git a/docs/symbols/$_.event.html b/docs/symbols/$_.event.html index dc62e66..e531fe9 100644 --- a/docs/symbols/$_.event.html +++ b/docs/symbols/$_.event.html @@ -1,421 +1 @@ - - - - - - - JsDoc Reference - $_.event - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- - - -
- Kis JS Docs -
- - - -
- -

- Namespace $_.event -

- - - -
-

-
- -

Defined in: event.js.

- - - - - - - - - - - - -
-
Method Summary
-
- -
- - add(string, function) - Adds an event that returns a callback when triggered on the selected event and selector -
- -
- - remove(string, string) - Removes an event bound the the specified selector, event type, and callback -
- -
- - live(string, string, function) - Binds a persistent event to the document -
- -
- - delegate(string, string, function) - Binds an event to a parent object -
- -
-
- - - - - - - - - - - -
-
- Method Detail -
-
- - -
- -
- $_.event.add(string, function) - -
-
- Adds an event that returns a callback when triggered on the selected -event and selector - - - - -
Eg. $_("#selector").event.add("click", do_something());
- -
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - event -
- - - function - - callback -
- - - - - - - - -
- - -
- -
- $_.event.remove(string, string) - -
-
- Removes an event bound the the specified selector, event type, and callback - - - - -
Eg. $_("#selector").event.remove("click", do_something());
- -
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - event -
- - - string - - callback -
- - - - - - - - -
- - -
- -
- $_.event.live(string, string, function) - -
-
- Binds a persistent event to the document - - - - -
Eg. $_.event.live(".button", "click", do_something());
- -
- - -
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- - - string - - target -
- - - string - - event -
- - - function - - callback -
- - - - - - - - -
- - -
- -
- $_.event.delegate(string, string, function) - -
-
- Binds an event to a parent object - - - - -
Eg. $_("#parent").delegate(".button", "click", do_something());
- -
- - -
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- - - string - - target -
- - - string - - event_type -
- - - function - - callback -
- - - - - - - - -
- -
-
- - -
- - -
- ©2011

- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
- -
-
- - - +JsDoc Reference - $_.event
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Module $_.event

Defined in: event.js.

Method Summary
add(string, function)Adds an event that returns a callback when triggered on the selected event and selector
remove(string, string)Removes an event bound the the specified selector, event type, and callback
live(string, string, function)Binds a persistent event to the document
delegate(string, string, function)Binds an event to a parent object
Method Detail
$_.event.add(string, function)
Adds an event that returns a callback when triggered on the selected event and selector
Eg. $_("#selector").event.add("click", do_something());
Parameters:
string event
function callback
$_.event.remove(string, string)
Removes an event bound the the specified selector, event type, and callback
Eg. $_("#selector").event.remove("click", do_something());
Parameters:
string event
string callback
$_.event.live(string, string, function)
Binds a persistent event to the document
Eg. $_.event.live(".button", "click", do_something());
Parameters:
string target
string event
function callback
$_.event.delegate(string, string, function)
Binds an event to a parent object
Eg. $_("#parent").delegate(".button", "click", do_something());
Parameters:
string target
string event_type
function callback
\ No newline at end of file diff --git a/docs/symbols/$_.html b/docs/symbols/$_.html index 06ffdfa..e5bf475 100644 --- a/docs/symbols/$_.html +++ b/docs/symbols/$_.html @@ -1,719 +1 @@ - - - - - - - JsDoc Reference - $_ - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- - - -
- Kis JS Docs -
- - - -
- -

- Namespace $_ -

- - - -
-

-
- -

Defined in: core.js.

- - - - - - - - - -
-
Field Summary
-
- -
- - dom - DOM Dom manipulation module -
- -
- - store - Wrapper for localstorage / sessionstorage data serialization. -
- -
- - util - String and object manipulation utilities -
- -
- - event - Event Listener module -
- -
-
- - - - - - - -
-
Method Summary
-
- -
- - $(string, object) - Simple DOM selector function -
- -
- - ext(string, object) - Adds the property `obj` to the $_ object, calling it `name` -
- -
- - each(function) - Iterates over a $_ object, applying a callback to each item -
- -
- - type(mixed) - Retrieves the type of the passed variable -
- -
- - get(string, object, function) - Sends a GET type ajax request -
- -
- - post(string, object, function) - Sends a POST type ajax request -
- -
-
- - - - - - - - -
-
- Field Detail -
-
- -
- -
- $_.dom - -
- -
- DOM - -Dom manipulation module - -

Defined in: DOM.js.

- - -
- - -

-									
-								
-									
-										
-										
-										
-										
-				
-								
- -
- -
- $_.store - -
- -
- Wrapper for localstorage / sessionstorage data serialization. -Each method has a boolean parameter, that when set as true switches the method -to use sessionStorage rather than the default localStorage. - -

Defined in: store.js.

- - -
- - -

-									
-								
-									
-										
-										
-										
-										
-				
-								
- -
- -
- $_.util - -
- -
- String and object manipulation utilities - -

Defined in: util.js.

- - -
- - -

-									
-								
-									
-										
-										
-										
-										
-				
-								
- -
- -
- $_.event - -
- -
- Event Listener module - -

Defined in: event.js.

- - -
- - -

-									
-								
-									
-										
-										
-										
-										
-				
-								
- -
-
- - - - -
-
- Method Detail -
-
- - -
- -
- $_.$(string, object) - : object -
-
- Simple DOM selector function - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - selector -
- - - object - - context -
- - - - - -
Returns:
- - - - - - - -
- - - object -
- - - - -
- - -
- -
- $_.ext(string, object) - -
-
- Adds the property `obj` to the $_ object, calling it `name` - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - name -
- - - object - - obj -
- - - - - - - - -
- - -
- -
- $_.each(function) - -
-
- Iterates over a $_ object, applying a callback to each item - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - function - - callback -
- - - - - - - - -
- - -
- -
- $_.type(mixed) - : string -
-
- Retrieves the type of the passed variable - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - mixed - - obj -
- - - - - -
Returns:
- - - - - - - -
- - - string -
- - - - -
- - -
- -
- $_.get(string, object, function) - -
-
- Sends a GET type ajax request - -

Defined in: ajax.js.

- - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- - - string - - url -
- - - object - - data -
- - - function - - callback -
- - - - - - - - -
- - -
- -
- $_.post(string, object, function) - -
-
- Sends a POST type ajax request - -

Defined in: ajax.js.

- - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- - - string - - url -
- - - object - - data -
- - - function - - callback -
- - - - - - - - -
- -
-
- - -
- - -
- ©2011

- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
- -
-
- - - +JsDoc Reference - $_
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Module $_

Defined in: core.js.

Field Summary
domDOM Dom manipulation module
storeWrapper for localstorage / sessionstorage data serialization.
utilString and object manipulation utilities
eventEvent Listener module
Method Summary
$(string, object)Simple DOM selector function
ext(string, object)Adds the property `obj` to the $_ object, calling it `name`
each(function)Iterates over a $_ object, applying a callback to each item
type(mixed)Retrieves the type of the passed variable
get(string, object, function)Sends a GET type ajax request
post(string, object, function)Sends a POST type ajax request
Field Detail
$_.dom
DOM Dom manipulation module

Defined in: DOM.js.

$_.store
Wrapper for localstorage / sessionstorage data serialization. Each method has a boolean parameter, that when set as true switches the method to use sessionStorage rather than the default localStorage.

Defined in: store.js.

$_.util
String and object manipulation utilities

Defined in: util.js.

$_.event
Event Listener module

Defined in: event.js.

Method Detail
$_.$(string, object): object
Simple DOM selector function
Parameters:
string selector
object context
Returns:
object
$_.ext(string, object)
Adds the property `obj` to the $_ object, calling it `name`
Parameters:
string name
object obj
$_.each(function)
Iterates over a $_ object, applying a callback to each item
Parameters:
function callback
$_.type(mixed): string
Retrieves the type of the passed variable
Parameters:
mixed obj
Returns:
string
$_.get(string, object, function)
Sends a GET type ajax request

Defined in: ajax.js.

Parameters:
string url
object data
function callback
$_.post(string, object, function)
Sends a POST type ajax request

Defined in: ajax.js.

Parameters:
string url
object data
function callback
\ No newline at end of file diff --git a/docs/symbols/$_.store.html b/docs/symbols/$_.store.html index fd79a07..e6b769a 100644 --- a/docs/symbols/$_.store.html +++ b/docs/symbols/$_.store.html @@ -1,478 +1 @@ - - - - - - - JsDoc Reference - $_.store - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- - - -
- Kis JS Docs -
- - - -
- -

- Namespace $_.store -

- - - -
-

-
- -

Defined in: store.js.

- - - - - - - - - - - - -
-
Method Summary
-
- -
- - get(string, bool) - Retrieves and deserializes a value from localstorage, based on the specified key -
- -
- - set(string, mixed, bool) - Puts a value into localstorage at the specified key, and JSON-encodes the value if not a string -
- -
- - remove(string, bool) - Removes the specified item from storage -
- -
- - getAll(bool) - Returns an object of all the raw values in storage -
- -
- - clear(bool) - Removes all values from the same domain storage -
- -
-
- - - - - - - - - - - -
-
- Method Detail -
-
- - -
- -
- $_.store.get(string, bool) - : object -
-
- Retrieves and deserializes a value from localstorage, -based on the specified key - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - key -
- - - bool - - session -
- - - - - -
Returns:
- - - - - - - -
- - - object -
- - - - -
- - -
- -
- $_.store.set(string, mixed, bool) - -
-
- Puts a value into localstorage at the specified key, -and JSON-encodes the value if not a string - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- - - string - - key -
- - - mixed - - value -
- - - bool - - session -
- - - - - - - - -
- - -
- -
- $_.store.remove(string, bool) - -
-
- Removes the specified item from storage - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - string - - key -
- - - bool - - session -
- - - - - - - - -
- - -
- -
- $_.store.getAll(bool) - : object -
-
- Returns an object of all the raw values in storage - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - bool - - session -
- - - - - -
Returns:
- - - - - - - -
- - - object -
- - - - -
- - -
- -
- $_.store.clear(bool) - -
-
- Removes all values from the same domain storage - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - bool - - session -
- - - - - - - - -
- -
-
- - -
- - -
- ©2011

- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
- -
-
- - - +JsDoc Reference - $_.store
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Module $_.store

Defined in: store.js.

Method Summary
get(string, bool)Retrieves and deserializes a value from localstorage, based on the specified key
set(string, mixed, bool)Puts a value into localstorage at the specified key, and JSON-encodes the value if not a string
remove(string, bool)Removes the specified item from storage
getAll(bool)Returns an object of all the raw values in storage
clear(bool)Removes all values from the same domain storage
Method Detail
$_.store.get(string, bool): object
Retrieves and deserializes a value from localstorage, based on the specified key
Parameters:
string key
bool session
Returns:
object
$_.store.set(string, mixed, bool)
Puts a value into localstorage at the specified key, and JSON-encodes the value if not a string
Parameters:
string key
mixed value
bool session
$_.store.remove(string, bool)
Removes the specified item from storage
Parameters:
string key
bool session
$_.store.getAll(bool): object
Returns an object of all the raw values in storage
Parameters:
bool session
Returns:
object
$_.store.clear(bool)
Removes all values from the same domain storage
Parameters:
bool session
\ No newline at end of file diff --git a/docs/symbols/$_.util.html b/docs/symbols/$_.util.html index 3f373a6..c82a60a 100644 --- a/docs/symbols/$_.util.html +++ b/docs/symbols/$_.util.html @@ -1,517 +1 @@ - - - - - - - JsDoc Reference - $_.util - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- - - -
- Kis JS Docs -
- - - -
- -

- Namespace $_.util -

- - - -
-

-
- -

Defined in: util.js.

- - - - - - - - - - - - -
-
Method Summary
-
- -
- - object_keys(object) - Retrieve the keys, or member names of an object -
- -
- - object_values(object) - Retrieves the values of an object, and returns them as an array -
- -
- - array_combine(array/object, array/object) - Creates an object, with the property names of the first array, and the values of the second. -
- -
- - object_merge(object) - Combines two or more objects/arrays. -
- -
- - str_trans(string, mixed, string) - Replaces sections of strings in a greedy fashion, starting with the longest replace pairs first. -
- -
-
- - - - - - - - - - - -
-
- Method Detail -
-
- - -
- -
- $_.util.object_keys(object) - : array -
-
- Retrieve the keys, or member names of an object - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - object - - -
- - - - - -
Returns:
- - - - - - - -
- - - array -
- - - - -
- - -
- -
- $_.util.object_values(object) - : array -
-
- Retrieves the values of an object, and returns -them as an array - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - object - - -
- - - - - -
Returns:
- - - - - - - -
- - - array -
- - - - -
- - -
- -
- $_.util.array_combine(array/object, array/object) - : object -
-
- Creates an object, with the property names of the first array, -and the values of the second. If objects are passed, the values -of the object are used. If the arrays or objects passed are -not the same size, the function will return false. - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - -
- - - array/object - - keys -
- - - array/object - - vals -
- - - - - -
Returns:
- - - - - - - -
- - - object -
- - - - -
- - -
- -
- $_.util.object_merge(object) - : object -
-
- Combines two or more objects/arrays. If the keys are numeric, the outputted -object will have re-indexed keys. If a key/value pair exists in both objects, -indentical values will be droped, but if a key exists with a different value, -with the same key, the value in the second array will replace the value in the -first - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - -
- - - object - - [as many as you wish to combine] -
- - - - - -
Returns:
- - - - - - - -
- - - object -
- - - - -
- - -
- -
- $_.util.str_trans(string, mixed, string) - : string -
-
- Replaces sections of strings in a greedy fashion, -starting with the longest replace pairs first. Accepts -one replace pair as two parameters, or an object, with -from => to replacements as key/value pairs - - - - -

-										
-									
- - -
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- - - string - - input_string -
- - - mixed - - from (string)/replace pairs (object) -
- - - string?, Default: - - -
- - - - - -
Returns:
- - - - - - - -
- - - string -
- - - - -
- -
-
- - -
- - -
- ©2011

- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
- -
-
- - - +JsDoc Reference - $_.util
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Module $_.util

Defined in: util.js.

Method Summary
object_keys(object)Retrieve the keys, or member names of an object
object_values(object)Retrieves the values of an object, and returns them as an array
array_combine(array/object, array/object)Creates an object, with the property names of the first array, and the values of the second.
object_merge(object)Combines two or more objects/arrays.
str_trans(string, mixed, string)Replaces sections of strings in a greedy fashion, starting with the longest replace pairs first.
Method Detail
$_.util.object_keys(object): array
Retrieve the keys, or member names of an object
Parameters:
object
Returns:
array
$_.util.object_values(object): array
Retrieves the values of an object, and returns them as an array
Parameters:
object
Returns:
array
$_.util.array_combine(array/object, array/object): object
Creates an object, with the property names of the first array, and the values of the second. If objects are passed, the values of the object are used. If the arrays or objects passed are not the same size, the function will return false.
Parameters:
array/object keys
array/object vals
Returns:
object
$_.util.object_merge(object): object
Combines two or more objects/arrays. If the keys are numeric, the outputted object will have re-indexed keys. If a key/value pair exists in both objects, indentical values will be droped, but if a key exists with a different value, with the same key, the value in the second array will replace the value in the first
Parameters:
object [as many as you wish to combine]
Returns:
object
$_.util.str_trans(string, mixed, string): string
Replaces sections of strings in a greedy fashion, starting with the longest replace pairs first. Accepts one replace pair as two parameters, or an object, with from => to replacements as key/value pairs
Parameters:
string input_string
mixed from (string)/replace pairs (object)
string?, Default:
Returns:
string
\ No newline at end of file diff --git a/docs/symbols/_global_.html b/docs/symbols/_global_.html index 2fb2446..ce73b8f 100644 --- a/docs/symbols/_global_.html +++ b/docs/symbols/_global_.html @@ -1,119 +1 @@ - - - - - - - JsDoc Reference - _global_ - - - - - - - - - -
-
- -
-
-
-
 
-
Project Outline
-
- - -
- -
- -
-
-
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
- -
-
-
 
$_.dom
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
- -
-
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
- -
-
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
- -
-
-
 
$_.util
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
- -
-
- -
-
-
- - -
-
«
- - - -
- Kis JS Docs -
- - - -
- -

- Built-In Namespace _global_ -

- - - -
-

-
- - - - - - - - - - - - - - - - - - - - -
- - -
- ©2011

- Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) -
- -
-
- - - +JsDoc Reference - _global_
 
Project Outline
 
$_
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
addClass(string)
removeClass(string)
show(string)
attr(string, string)
text(string)
css(string, string)
html(string)
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
object_keys(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
«
Kis JS Docs

Built-In Module _global_

\ No newline at end of file