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

fix documentation

Browse source
This commit is contained in:
rolux 2012-05-30 00:28:52 +02:00
commit 6847102507
4 changed files with 29 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,18 +1,14 @@
'use strict';
/*@
Ox.List <f:Ox.Container> List Element
([options[, self]]) -> <f> List Object
Ox.List <f:Ox.Container> List constructor
options <o> Options object
centered <b|false> if true, and orientation is 'horizontal',
then keep the selected item centered
centered <b|false> if true, and orientation is 'horizontal', then keep the selected item centered
construct <f|null> (data) returns the list item HTML
draggable <b|false> If true, items can be dragged
format <[]> ???
itemHeight <n|16> item height
items <a|f|null> <a> list of items,
<f> (data) returns {items, size, ...}
(data, callback) returns [items]
items <a|f|null> <a> list of items, <f> (data) returns {items, size, ...}, (data, callback) returns [items]
itemWidth <n|16> item width
keys <a|[]> keys of the list items
max <n|-1> Maximum number of items that can be selected (-1 for all)
@ -22,25 +18,26 @@ Ox.List <f:Ox.Container> List Element
selected <a|[]> ids of the selected elements
sort <a|[]> sort order
sortable <b|false> If true, items can be re-ordered
sums <[]|[]> sums to be included in totals
type <s|'text'>
sums <[s]|[]> sums to be included in totals
type <s|'text'> type
unique <s|''> name of the key that acts as unique id
self <o> shared private variable
add <!> item added
delete <!> item removed
draganddrop <!> Fires during drag
draganddropend <!> Fires on drop
draganddropenter <!> Fires when entering an item during drag
draganddropleave <!> Fires when leaving an item during drag
draganddroppause <!> Fires when the mouse stops during drag
draganddropstart <i> Fires when drag starts
copy <!> copy
paste <!> paste
move <!> move item
load <!> list loaded
openpreview <!> preview of selected item opened
closepreview <!> preview closed
select <!> select item
([options[, self]]) -> <o> List object
add <!> item added
delete <!> item removed
draganddrop <!> Fires during drag
draganddropend <!> Fires on drop
draganddropenter <!> Fires when entering an item during drag
draganddropleave <!> Fires when leaving an item during drag
draganddroppause <!> Fires when the mouse stops during drag
draganddropstart <i> Fires when drag starts
copy <!> copy
paste <!> paste
move <!> move item
load <!> list loaded
openpreview <!> preview of selected item opened
closepreview <!> preview closed
select <!> select item
@*/
// fixme: rename the add event to new, or the delete event to remove