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/Form/ArrayEditable.js
View file

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

4
source/Ox.UI/js/Form/ArrayInput.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.ArrayInput <f:Ox.Element> Array input
(options, self) -> <o> Array input
Ox.ArrayInput <f> Array input
([options[, self]]) -> <o:Ox.Element> Array input
options <o> Options object
label <s> string, ''
max <n> integer, maximum number of items, 0 for all

6
source/Ox.UI/js/Form/Button.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.Button <f:Ox.Element> Button Object
() -> <o> Button Object
(options) -> <o> Button Object
(options, self) -> <o> Button Object
Ox.Button <f> Button Object
([options[, self]]) -> <o:Ox.Element> Button Object
options <o> Options object
If a button is both selectable and has two values, its value is the
selected id, and the second value corresponds to the selected state

8
source/Ox.UI/js/Form/ButtonGroup.js
View file

@ -1,12 +1,10 @@
'use strict';
/*@
Ox.ButtonGroup <f:Ox.Element> ButtonGroup Object
() -> <o> ButtonGroup Object
(options) -> <o> ButtonGroup Object
(options, self) -> <o> ButtonGroup Object
Ox.ButtonGroup <f> ButtonGroup Object
([options[, self]]) -> <o:Ox.Element> ButtonGroup Object
options <o> Options object
buttons <a> array of buttons
buttons <[o]> array of button options
max <n> integer, maximum number of selected buttons, 0 for all
min <n> integer, minimum number of selected buttons, 0 for none
selectable <b> if true, buttons are selectable

6
source/Ox.UI/js/Form/Checkbox.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.Checkbox <f:Ox.Element> Checkbox Element
() -> <o> Checkbox Element
(options) -> <o> Checkbox Element
(options, self) -> <o> Checkbox Element
Ox.Checkbox <f> Checkbox Element
([options[, self]]) -> <o:Ox.Element> Checkbox Element
options <o> Options object
disabled <b> if true, checkbox is disabled
group <b> if true, checkbox is part of a group

6
source/Ox.UI/js/Form/CheckboxGroup.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.CheckboxGroup <f:Ox.Element> CheckboxGroup Object
() -> <o> CheckboxGroup Object
(options) -> <o> CheckboxGroup Object
(options, self) -> <o> CheckboxGroup Object
Ox.CheckboxGroup <f> CheckboxGroup Object
([options[, self]]) -> <o:Ox.Element> CheckboxGroup Object
options <o> Options object
checkboxes <a|[]> array of checkboxes
max <n|1> max selected

6
source/Ox.UI/js/Form/ColorInput.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.ColorInput <f:Ox.InputGroup> ColorInput Element
() -> <o> ColorInput Element
(options) -> <o> ColorInput Element
(options, self) -> <o> ColorInput Element
Ox.ColorInput <f> ColorInput Element
([options[, self]]) -> <o:Ox.InputGroup> ColorInput Element
options <o> Options object
id <s> element id
value <s|0, 0, 0> rgb value

6
source/Ox.UI/js/Form/ColorPicker.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.ColorPicker <f:Ox.Element> ColorPicker Element
() -> <o> ColorPicker Element
(options) -> <o> ColorPicker Element
(options, self) -> <o> ColorPicker Element
Ox.ColorPicker <f> ColorPicker Element
([options[, self]]) -> <o:Ox.Picker> ColorPicker Element
options <o> Options object
id <s> element id
value <s|0, 0, 0> rgb value

4
source/Ox.UI/js/Form/DateInput.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.DateInput <f:Ox.InputGroup> DateInput Element
([options[, self]]) -> <o> DateInput Element
Ox.DateInput <f> DateInput Element
([options[, self]]) -> <o:Ox.InputGroup> DateInput Element
options <o> Options object
format <s|short> format can be short, medium, long
value <d> date value, defaults to current date

4
source/Ox.UI/js/Form/DateTimeInput.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.DateTimeInput <f:Ox.InputGroup> DateTimeInput Element
([options[, self]]) -> <o> DateTimeInput Element
Ox.DateTimeInput <f> DateTimeInput Element
([options[, self]]) -> <o:Ox.InputGroup> DateTimeInput Element
options <o> Options object
ampm <b|false> false is 24h true is am/pm
format <s|short> options are short, medium, long

4
source/Ox.UI/js/Form/Editable.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Editable <f:Ox.Element> Editable element
([options[, self]]) -> <o> Input Element
Ox.Editable <f> Editable element
([options[, self]]) -> <o:Ox.Element> Input Element
options <o> Options object
editing <b|false> If true, loads in editing state
format <f|null> Format function

4
source/Ox.UI/js/Form/FileButton.js
View file

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

4
source/Ox.UI/js/Form/FileInput.js
View file

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

4
source/Ox.UI/js/Form/Filter.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Filter <f:Ox.Element> Filter Object
([options[, self]]) -> <o> Filter Object
Ox.Filter <f> Filter Object
([options[, self]]) -> <o:Ox.Element> Filter Object
options <o> Options object
findKeys <[]|[]> keys
list <o> list object

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Form <f:Ox.Element> Form Object
([options[, self]]) -> <o> Form Object
Ox.Form <f> Form Object
([options[, self]]) -> <o:Ox.Element> Form Object
options <o> Options object
error <s> error
id <s> id

6
source/Ox.UI/js/Form/FormElementGroup.js
View file

@ -1,11 +1,11 @@
'use strict';
/*@
Ox.FormElementGroup <f:Ox.Element> FormElementGroup Element
([options[, self]]) -> <f> FormElementGroup Element
Ox.FormElementGroup <f> FormElementGroup Element
([options[, self]]) -> <o:Ox.Element> FormElementGroup Element
options <o> Options object
id <s> element id
elements <a|[]> elements in group
elements <[o:Ox.Element]|[]> elements in group
float <s|left> alignment
separators <a|[]> separators (not implemented)
width <n|0> group width

4
source/Ox.UI/js/Form/FormItem.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.FormItem <f:Ox.Element> FormItem Element, wrap form element with an error message
([options[, self]]) -> <f> FormItem Element
Ox.FormItem <f> FormItem Element, wraps form element with an error message
([options[, self]]) -> <o:Ox.Element> FormItem Element
options <o> Options object
element <o|null> element
error <s> error message

4
source/Ox.UI/js/Form/FormPanel.js
View file

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

4
source/Ox.UI/js/Form/Input.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Input <f:Ox.Element> Input Element
([options[, self]]) -> <o> Input Element
Ox.Input <f> Input Element
([options[, self]]) -> <o:Ox.Element> Input Element
options <o> Options object
arrows <b> if true, and type is 'float' or 'int', display arrows
arrowStep <n> step when clicking arrows

4
source/Ox.UI/js/Form/InputGroup.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.InputGroup <f:Ox.Element> InputGroup Object
([options[, self]]) -> <o> InputGroup Object
Ox.InputGroup <f> InputGroup Object
([options[, self]]) -> <o:Ox.Element> InputGroup Object
options <o> Options object
id <s|''> id
inputs <a|[]> inputs

4
source/Ox.UI/js/Form/InsertHTMLDialog.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.InsertHTMLDialog <f:Ox.Dialog> Insert HTML Dialog
([options[, self]]) -> <o> Insert HTML Dialog
Ox.InsertHTMLDialog <f> Insert HTML Dialog
([options[, self]]) -> <o:Ox.Dialog> Insert HTML Dialog
options <o> Options
self <o> Shared private variable
@*/

4
source/Ox.UI/js/Form/Label.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Label <f:Ox.Element> Label Object
([options[, self]]) -> <o> Label Object
Ox.Label <f> Label element
([options[, self]]) -> <o:Ox.Element> Label element
options <o> Options object
@*/
Ox.Label = function(options, self) {

4
source/Ox.UI/js/Form/ObjectArrayInput.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.ObjectArrayInput <f:Ox.Element> Object Array Input
([options[, self]]) -> <o> Object Array Input
Ox.ObjectArrayInput <f> Object Array Input
([options[, self]]) -> <o:Ox.Element> Object Array Input
options <o> Options
buttonTitles
inputs

4
source/Ox.UI/js/Form/ObjectInput.js
View file

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

4
source/Ox.UI/js/Form/Picker.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Picker <f:Ox.Element> Picker Object
([options[, self]]) -> <o> Picker Object
Ox.Picker <f> Picker Object
([options[, self]]) -> <o:Ox.Element> Picker Object
options <o> Options object
element <o|null> picker element
elementHeight <n|128> height

4
source/Ox.UI/js/Form/PlaceInput.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.PlaceInput <f:Ox.FormElementGroup> PlaceInput Object
([options[, self]]) -> <f> PlaceInput Object
Ox.PlaceInput <f> PlaceInput Object
([options[, self]]) -> <o:Ox.FormElementGroup> PlaceInput Object
options <o> Options object
id <s> element id
value <s|United States> default value of place input

4
source/Ox.UI/js/Form/PlacePicker.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.PlacePicker <f:Ox.Picker> PlacePicker Object
([options[, self]]) -> <o> PlacePicker Object
Ox.PlacePicker <f> PlacePicker Object
([options[, self]]) -> <o:Ox.Picker> PlacePicker Object
options <o> Options object
id <s> element id
value <s|United States> default value of place input

4
source/Ox.UI/js/Form/Range.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Range <f:Ox.Element> Range Object
([options[, self]]) -> <o> Range Object
Ox.Range <f> Range Object
([options[, self]]) -> <o:Ox.Element> Range Object
options <o> Options object
arrows <b> if true, show arrows
arrowStep <n> step when clicking arrows

4
source/Ox.UI/js/Form/Select.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Select <f:Ox.Element> Select Object
([options[, self]) -> <o> Select Object
Ox.Select <f> Select Object
([options[, self]) -> <o:Ox.Element> Select Object
options <o> Options object
disabled <b|false> If true, select is disabled
id <s> Element id

4
source/Ox.UI/js/Form/SelectInput.js
View file

@ -1,8 +1,8 @@
'use strict';
//FIXME: does not work without options
/*@
Ox.SelectInput <f:Ox.FormElementGroup> Select Input
([options[, self]]) -> <o> Select Input
Ox.SelectInput <f> Select Input
([options[, self]]) -> <o:Ox.FormElementGroup> Select Input
options <o> Options
self <o> Shared private variable
@*/

4
source/Ox.UI/js/Form/Spreadsheet.js
View file

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

4
source/Ox.UI/js/Form/TimeInput.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.TimeInput <f:Ox.Element> TimeInput Object
([options[, self]]) -> <f> TimeInput Object
Ox.TimeInput <f> TimeInput Object
([options[, self]]) -> <o:Ox.InputGroup> TimeInput Object
options <o> Options object
ampm <b|false> 24h/ampm
seconds <b|false> show seconds