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

add documentation stubs

Browse source
This commit is contained in:
j 2012-05-21 12:38:18 +02:00
commit 509745407b
102 changed files with 613 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=js
'use strict';
/*@

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

@ -1,4 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=js
'use strict';
/*@
Ox.IconList <f:Ox.Element> IconList Object
@ -155,15 +154,24 @@ Ox.IconList = function(options, self) {
return that;
};
/*@
gainFocus <f> gainFocus
@*/
that.gainFocus = function() {
that.$element.gainFocus();
return that;
};
/*@
hasFocus <f> hasFocus
@*/
that.hasFocus = function() {
return that.$element.hasFocus();
};
/*@
loseFocus <f> loseFocus
@*/
that.loseFocus = function() {
that.$element.loseFocus();
return that;

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

@ -1,5 +1,11 @@
'use strict';
/*@
Ox.InfoList <function> Info List
(options[, self]) -> <o> Info List
options <o> Options
self <o> Shared private variable
@*/
Ox.InfoList = function(options, self) {
self = self || {};
@ -171,44 +177,72 @@ Ox.InfoList = function(options, self) {
}
};
/*@
closePreivew <f> closePreview
@*/
that.closePreview = function() {
that.$element.closePreview();
return that;
};
/*@
gainFocus <f> gainFocus
@*/
that.gainFocus = function() {
that.$element.gainFocus();
return that;
};
/*@
hasFocus <f> hasFocus
@*/
that.hasFocus = function() {
return that.$element.hasFocus();
};
/*@
loseFocus <f> loseFocus
@*/
that.loseFocus = function() {
that.$element.loseFocus();
return that;
};
/*@
paste <f> paste
@*/
that.paste = function(data) {
that.$element.paste(data);
return that;
};
/*@
reloadList <f> reloadList
@*/
that.reloadList = function(stayAtPosition) {
that.$element.reloadList(stayAtPosition);
return that;
};
/*@
scrollToSelection <f> scrollToSelection
@*/
that.scrollToSelection = function() {
that.$element.scrollToSelection();
return that;
};
/*@
size <f> size
@*/
that.size = function() {
that.$element.size();
};
/*@
sortList <f> sortList
(key, operator) -> <o>
@*/
that.sortList = function(key, operator) {
self.options.sort = [{
key: key,
@ -219,6 +253,12 @@ Ox.InfoList = function(options, self) {
return that;
};
/*@
value <f> value
(id) -> values
(id, key) -> value
(id, key, value) -> <o>
@*/
that.value = function(id, key, value) {
// fixme: make this accept id, {k: v, ...}
if (arguments.length == 1) {
@ -233,4 +273,4 @@ Ox.InfoList = function(options, self) {
return that;
};
};

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

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -1633,6 +1631,10 @@ Ox.List = function(options, self) {
return that;
}
/*@
sort <f> sort
@*/
// needed when a value has changed
// but, fixme: better function name
that.sort = function() {

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

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@

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

@ -1,5 +1,5 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
Ox.ListPage <f:Ox.Element> ListPage Object
() -> <f> ListPage Object

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

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -838,11 +836,18 @@ Ox.TextList = function(options, self) {
*/
}
/*@
closePreivew <f> closePreview
@*/
that.closePreview = function() {
that.$body.closePreview();
return that;
};
/*@
editCell <f> editCell
(id, key, select) -> <u> edit cell
@*/
that.editCell = function(id, key, select) {
Ox.Log('List', 'editCell', id, key)
var $item = getItem(id),
@ -894,40 +899,67 @@ Ox.TextList = function(options, self) {
}
}
/*@
gainFocus <f> gainFocus
@*/
that.gainFocus = function() {
that.$body.gainFocus();
return that;
};
/*@
hasFocus <f> hasFocus
@*/
that.hasFocus = function() {
return that.$body.hasFocus();
};
/*@
loseFocus <f> loseFocus
@*/
that.loseFocus = function() {
that.$body.loseFocus();
return that;
};
/*@
openPreview <f> openPreview
@*/
that.openPreview = function() {
that.$body.openPreview();
return that;
};
/*@
paste <f> paste
(data) -> <o> paste data
@*/
that.paste = function(data) {
that.$body.paste();
return that;
};
/*@
reloadList <f> reloadList
(stayAtPosition) -> <o> reload list
@*/
that.reloadList = function(stayAtPosition) {
that.$body.reloadList(stayAtPosition);
return that;
};
/*@
resizeColumn <f> resizeColumn
(id, width) -> <o> resize column id to width
@*/
that.resizeColumn = function(id, width) {
resizeColumn(id, width);
return that;
}
/*@
size <f> size
@*/
that.size = function() {
setWidth();
that.$body.size();
@ -966,6 +998,12 @@ Ox.TextList = function(options, self) {
return that;
};
/*@
value <f> value
(id) -> get values of row id
(id, key) -> get value of cell id, key
(id, key, value) -> set id, key to value
@*/
that.value = function(id, key, value) {
// fixme: make this accept id, {k: v, ...}
//Ox.Log('List', 'value', id, key, value)

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

@ -1,5 +1,3 @@
// vim: et:ts=4:sw=4:sts=4:ft=javascript
'use strict';
/*@
@ -259,15 +257,24 @@ Ox.TreeList = function(options, self) {
}
};
/*@
gainFocus <f> gainFocus
@*/
that.gainFocus = function() {
self.$list.gainFocus();
return that;
};
/*@
hasFocus <f> hasFocus
@*/
that.hasFocus = function() {
return self.$list.hasFocus();
};
/*@
loseFocus <f> loseFocus
@*/
that.loseFocus = function() {
self.$list.loseFocus();
return that;