0x2620/oxjs
2
0
Fork 2
Code Issues 172 Pull requests Releases Wiki Activity

update widget documentation (arguments first)

Browse source
This commit is contained in:
rolux 2012-07-04 13:29:18 +02:00
commit a0867f0da6
81 changed files with 250 additions and 251 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,7 +2,6 @@
/*@
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, ...}, ...}
@ -14,7 +13,7 @@ Ox.Chart <f> Bar Chart
title <s|''> Chart title
width <n|512> Chart width
self <o> shared private variable
([options[, self]]) -> <o:Ox.Element> Chart object
@*/
Ox.Chart = function(options, self) {

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

@ -2,7 +2,6 @@
/*@
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
@ -16,6 +15,7 @@ Ox.IconItem <f> IconItem Object
title <s> Title
url <s> Icon url
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> IconItem Object
@*/
Ox.IconItem = function(options, self) {

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

@ -1,7 +1,6 @@
'use strict';
/*@
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
@ -23,7 +22,8 @@ Ox.IconList <f> IconList Object
selected <a|[]> array of selected items
size <n|128> list size
sort <a|[]> sort keys
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.List> IconList Object
@*/
Ox.IconList = function(options, self) {

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

@ -2,9 +2,9 @@
/*@
Ox.InfoList <f> Info List
([options[, self]]) -> <o:Ox.List> Info List
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.List> Info List
@*/
Ox.InfoList = function(options, self) {

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

@ -2,16 +2,16 @@
/*@
Ox.ListItem <f> ListItem Object
([options[, self]]) -> <o:Ox.Element> ListItem Object
cancel <!> triggered if cancel button is pressed
save <!> triggered if save button is pressed
options <o> Options object
construct <f> construct function
data <o|{}> item data
draggable <b|false> can be dragged
position <n|0> item position
unique <s|''> unique key
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> ListItem Object
cancel <!> triggered if cancel button is pressed
save <!> triggered if save button is pressed
@*/
Ox.ListItem = function(options, self) {

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

@ -2,9 +2,9 @@
/*@
Ox.ListPage <f> ListPage Object
([options[, self]]) -> <o:Ox.Element> ListPage Object
options <o> Options object
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> ListPage Object
@*/
Ox.ListPage = function(options, self) {
self = self || {};

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

@ -2,7 +2,6 @@
/*@
Ox.TableList <f> TableList Widget
([options[, self]]) -> <o:Ox.Element> TableList Object
options <o> Options object
columns <[o]|[]> Columns
# Fixme: There's probably more...
@ -42,7 +41,8 @@ Ox.TableList <f> TableList Widget
deprecated).
columnresize <!> columnresize
columnchange <!> columnchange
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> TableList Object
@*/
// fixme: options.columnsMovable, but options.sortable ... pick one.

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

@ -2,7 +2,6 @@
/*@
Ox.TreeList <f> Tree List
([options[, self]]) -> <o:Ox.List> Tree List Object
options <o> Options object
data <f|null> Data to be parsed as items (needs documentation)
expanded <b|false> If true, and data is not null, all items are expanded
@ -13,6 +12,7 @@ Ox.TreeList <f> Tree List
selected <a|[]> Selected ids
width <n|256> List width
self <o> Shared private variable
([options[, self]]) -> <o:Ox.List> Tree List Object
@*/
Ox.TreeList = function(options, self) {