sanj/oxjs
1
0
Fork 0
forked from 0x2620/oxjs
Code Pull requests Activity

update documentation (classes)

Browse source
This commit is contained in:
rolux 2012-05-31 12:32:54 +02:00
commit 8c347d9009
88 changed files with 177 additions and 227 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/Ox.UI/js/List/Chart.js vendored
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Chart <f:Ox.Element> Bar Chart
([options[, self]]) -> <o> Chart object
Ox.Chart <f> Bar Chart
([options[, self]]) -> <o:Ox.Element> Chart object
options <o> Options
color <[n]|[[n]]|[128, 128, 128]> Bar color
data <o> {k: v, ...} or {k: {k: v, ...}, ...}

4
source/Ox.UI/js/List/IconItem.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.IconItem <f:Ox.Element> IconItem Object
([options[, self]]) -> <o> IconItem Object
Ox.IconItem <f> IconItem Object
([options[, self]]) -> <o:Ox.Element> IconItem Object
options <o> Options object
borderRadius <n|0> Border radius for icon images
find <s|''> String to be highlighted

4
source/Ox.UI/js/List/IconList.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.IconList <f:Ox.Element> IconList Object
([options[, self]]) -> <o> IconList Object
Ox.IconList <f> IconList Object
([options[, self]]) -> <o:Ox.List> IconList Object
options <o> Options object
borderRadius <n|0> border radius for icon images
centerSelection <b|false> scroll list so selection is always centered

4
source/Ox.UI/js/List/InfoList.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.InfoList <f:Ox.Element> Info List
([options[, self]]) -> <o> Info List
Ox.InfoList <f> Info List
([options[, self]]) -> <o:Ox.List> Info List
options <o> Options
self <o> Shared private variable
@*/

4
source/Ox.UI/js/List/List.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.List <f:Ox.Container> List constructor
Ox.List <f> List constructor
options <o> Options object
centered <b|false> if true, and orientation is 'horizontal', then keep the selected item centered
construct <f|null> (data) returns the list item HTML
@ -22,7 +22,7 @@ Ox.List <f:Ox.Container> List constructor
type <s|'text'> type
unique <s|''> name of the key that acts as unique id
self <o> shared private variable
([options[, self]]) -> <o> List object
([options[, self]]) -> <o:Ox.Container> List object
add <!> item added
delete <!> item removed
draganddrop <!> Fires during drag

4
source/Ox.UI/js/List/ListItem.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.ListItem <f:Ox.Element> ListItem Object
([options[, self]]) -> <o> ListItem Object
Ox.ListItem <f> ListItem Object
([options[, self]]) -> <o:Ox.Element> ListItem Object
options <o> Options object
construct <f> construct function
data <o|{}> item data

4
source/Ox.UI/js/List/ListPage.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.ListPage <f:Ox.Element> ListPage Object
([options[, self]]) -> <o> ListPage Object
Ox.ListPage <f> ListPage Object
([options[, self]]) -> <o:Ox.Element> ListPage Object
options <o> Options object
self <o> shared private variable
@*/

4
source/Ox.UI/js/List/TextList.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.TextList <f:Ox.Element> TextList Object
([options[, self]]) -> <o> TextList Object
Ox.TextList <f> TextList Object
([options[, self]]) -> <o:Ox.Element> TextList Object
options <o> Options object
columns <[o]|[]> Columns
# Fixme: There's probably more...

4
source/Ox.UI/js/List/TreeList.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.TreeList <f:Ox.Element> TreeList Object
([options[, self]]) -> <o> TreeList Object
Ox.TreeList <f> TreeList Object
([options[, self]]) -> <o:Ox.List> TreeList Object
options <o> Options object
data <f|null> data to be parsed to items, needs documentation
items <a|[]> array of items