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

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

@ -2,6 +2,8 @@
/*@
Ox.ArrayEditable <f> Array Editable
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Array Editable
add <!> add
blur <!> blur
@ -15,8 +17,6 @@ Ox.ArrayEditable <f> Array Editable
selectnone <!> selectnone
select <!> select
submit <!> submit
options <o> Options object
self <o> Shared private variable
@*/
Ox.ArrayEditable = function(options, self) {

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

@ -2,7 +2,6 @@
/*@
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
@ -10,7 +9,8 @@ Ox.ArrayInput <f> Array input
value <[]> value
width <n|256> width
self <o> Shared private variable
change <!> change
([options[, self]]) -> <o:Ox.Element> Array input
change <!> change
@*/
Ox.ArrayInput = function(options, self) {

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

@ -2,7 +2,6 @@
/*@
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
@ -19,8 +18,9 @@ Ox.Button <f> Button Object
values <[o]|[]> [{id, title}, {id, title}]
width <s|'auto'> Button width
self <o> Shared private variable
click <!> non-selectable button was clicked
change <!> selectable button was clicked
([options[, self]]) -> <o:Ox.Element> Button Object
click <!> non-selectable button was clicked
change <!> selectable button was clicked
@*/
Ox.Button = function(options, self) {

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

@ -2,7 +2,6 @@
/*@
Ox.ButtonGroup <f> ButtonGroup Object
([options[, self]]) -> <o:Ox.Element> ButtonGroup Object
options <o> Options object
buttons <[o]> array of button options
max <n> integer, maximum number of selected buttons, 0 for all
@ -10,7 +9,8 @@ Ox.ButtonGroup <f> ButtonGroup Object
selectable <b> if true, buttons are selectable
type <s> string, 'image' or 'text'
self <o> Shared private variable
change <!> {id, value} selection within a group changed
([options[, self]]) -> <o:Ox.Element> ButtonGroup Object
change <!> {id, value} selection within a group changed
@*/
Ox.ButtonGroup = function(options, self) {

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

@ -2,8 +2,6 @@
/*@
Ox.Checkbox <f> Checkbox Element
([options[, self]]) -> <o:Ox.Element> Checkbox Element
change <!> triggered when value changes
options <o> Options object
disabled <b> if true, checkbox is disabled
group <b> if true, checkbox is part of a group
@ -13,6 +11,8 @@ Ox.Checkbox <f> Checkbox Element
value <b> if true, checkbox is checked
width <n> width in px
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Checkbox Element
change <!> triggered when value changes
@*/
Ox.Checkbox = function(options, self) {

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

@ -2,16 +2,16 @@
/*@
Ox.CheckboxGroup <f> CheckboxGroup Object
([options[, self]]) -> <o:Ox.Element> CheckboxGroup Object
change <!> triggered when checked property changes
passes {id, title, value}
options <o> Options object
checkboxes <a|[]> array of checkboxes
max <n|1> max selected
min <n|1> min selected
type <s|"group"> type ("group" or "list")
width <n> width in px
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> CheckboxGroup Object
change <!> triggered when checked property changes
passes {id, title, value}
@*/
Ox.CheckboxGroup = function(options, self) {

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

@ -2,12 +2,12 @@
/*@
Ox.ColorInput <f> ColorInput Element
([options[, self]]) -> <o:Ox.InputGroup> ColorInput Element
change <!> change
options <o> Options object
mode <s|'rgb'> Mode ('rgb' or 'hsl')
value <[n]|[0, 0, 0]> Value
self <o> Shared private variable
([options[, self]]) -> <o:Ox.InputGroup> ColorInput Element
change <!> change
@*/
Ox.ColorInput = function(options, self) {

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

@ -2,12 +2,12 @@
/*@
Ox.ColorPicker <f> ColorPicker Element
([options[, self]]) -> <o:Ox.Picker> ColorPicker Element
change <!> triggered on change of value
options <o> Options object
mode <s|'rgb'> Mode ('rgb' or 'hsl')
value <[n]|[0, 0, 0]> Value
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Picker> ColorPicker Element
change <!> triggered on change of value
@*/
Ox.ColorPicker = function(options, self) {

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

@ -2,8 +2,6 @@
/*@
Ox.DateInput <f> DateInput Element
([options[, self]]) -> <o:Ox.InputGroup> DateInput Element
change <!> triggered on change of value
options <o> Options object
format <s|short> format can be short, medium, long
value <d> date value, defaults to current date
@ -14,6 +12,8 @@ Ox.DateInput <f> DateInput Element
weekday <n> width of weekday input element
year <n> width of year input element
self <o> Shared private variable
([options[, self]]) -> <o:Ox.InputGroup> DateInput Element
change <!> triggered on change of value
@*/
Ox.DateInput = function(options, self) {

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

@ -2,8 +2,6 @@
/*@
Ox.DateTimeInput <f> DateTimeInput Element
([options[, self]]) -> <o:Ox.InputGroup> DateTimeInput Element
change <!> triggered on change of value
options <o> Options object
ampm <b|false> false is 24h true is am/pm
format <s|short> options are short, medium, long
@ -11,6 +9,8 @@ Ox.DateTimeInput <f> DateTimeInput Element
value <d> defautls to now
weekday <b|false> weekday
self <o> Shared private variable
([options[, self]]) -> <o:Ox.InputGroup> DateTimeInput Element
change <!> triggered on change of value
@*/
Ox.DateTimeInput = function(options, self) {

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

@ -2,18 +2,18 @@
/*@
Ox.Editable <f> Editable element
([options[, self]]) -> <o:Ox.Element> Input Element
blur <!> blur
cancel <!> cancel
edit <!> edit
open <!> open
submit <!> submit
options <o> Options object
editing <b|false> If true, loads in editing state
format <f|null> Format function
(value) -> <s> Formatted value
value <s> Input value
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Input Element
blur <!> blur
cancel <!> cancel
edit <!> edit
open <!> open
submit <!> submit
@*/
Ox.Editable = function(options, self) {

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

@ -2,8 +2,6 @@
/*@
Ox.Filter <f> Filter Object
([options[, self]]) -> <o:Ox.Element> Filter Object
change <!> change
options <o> Options object
findKeys <[]|[]> keys
list <o> list object
@ -19,6 +17,8 @@ Ox.Filter <f> Filter Object
sortKeys <a|[]> keys to sort by
viewKeys <a|[]> visible keys
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Filter Object
change <!> change
@*/
Ox.Filter = function(options, self) {

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

@ -2,15 +2,15 @@
/*@
Ox.Form <f> Form Object
([options[, self]]) -> <o:Ox.Element> Form Object
change <!> change
validate <!> validate
submit <!> submit
options <o> Options object
error <s> error
id <s> id
items <a|[]> []
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Form Object
change <!> change
validate <!> validate
submit <!> submit
@*/
Ox.Form = function(options, self) {

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

@ -2,10 +2,6 @@
/*@
Ox.FormElementGroup <f> FormElementGroup Element
([options[, self]]) -> <o:Ox.Element> FormElementGroup Element
autovalidate <!> autovalidate
change <!> change
validate <!> validate
options <o> Options object
id <s> element id
elements <[o:Ox.Element]|[]> elements in group
@ -13,6 +9,10 @@ Ox.FormElementGroup <f> FormElementGroup Element
separators <a|[]> separators (not implemented)
width <n|0> group width
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> FormElementGroup Element
autovalidate <!> autovalidate
change <!> change
validate <!> validate
@*/
Ox.FormElementGroup = function(options, self) {

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

@ -2,11 +2,11 @@
/*@
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
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> FormItem Element
@*/
Ox.FormItem = function(options, self) {

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

@ -2,11 +2,11 @@
/*@
Ox.FormPanel <f> Form Panel
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Form Panel
change <!> change
validate <!> validate
options <o> Options
self <o> Shared private variable
@*/
Ox.FormPanel = function(options, self) {

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

@ -2,17 +2,6 @@
/*@
Ox.Input <f> Input Element
([options[, self]]) -> <o:Ox.Element> Input Element
autocomplete <!> autocomplete
autovalidate <!> autovalidate
blur <!> blur
cancel <!> cancel
change <!> input changed event
clear <!> clear
focus <!> focus
insert <!> insert
submit <!> input submit event
validate <!> validate
options <o> Options object
arrows <b> if true, and type is 'float' or 'int', display arrows
arrowStep <n> step when clicking arrows
@ -65,7 +54,17 @@ Ox.Input <f> Input Element
value <s> string
validate <f> remote validation
width <n> px
([options[, self]]) -> <o:Ox.Element> Input Element
autocomplete <!> autocomplete
autovalidate <!> autovalidate
blur <!> blur
cancel <!> cancel
change <!> input changed event
clear <!> clear
focus <!> focus
insert <!> insert
submit <!> input submit event
validate <!> validate
@*/
Ox.Input = function(options, self) {

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

@ -2,15 +2,15 @@
/*@
Ox.InputGroup <f> InputGroup Object
([options[, self]]) -> <o:Ox.Element> InputGroup Object
change <!> change
validate <!> validate
options <o> Options object
id <s|''> id
inputs <a|[]> inputs
separators <a|[]> seperators
width <n|0> width
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> InputGroup Object
change <!> change
validate <!> validate
@*/
Ox.InputGroup = function(options, self) {

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

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

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

@ -2,8 +2,9 @@
/*@
Ox.Label <f> Label element
options <o|u> Options object
self <o|u> Shared private variable
([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

@ -2,8 +2,6 @@
/*@
Ox.ObjectArrayInput <f> Object Array Input
([options[, self]]) -> <o:Ox.Element> Object Array Input
change <!> change
options <o> Options
buttonTitles
inputs
@ -12,6 +10,8 @@ Ox.ObjectArrayInput <f> Object Array Input
value
width
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Object Array Input
change <!> change
@*/
Ox.ObjectArrayInput = function(options, self) {

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

@ -2,10 +2,10 @@
/*@
Ox.ObjectInput <f> Object Input
([options[, self]]) -> <o:Ox.Element> Object Input
change <!> change
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Object Input
change <!> change
@*/
Ox.ObjectInput = function(options, self) {

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

@ -2,15 +2,16 @@
/*@
Ox.Picker <f> Picker Object
([options[, self]]) -> <o:Ox.Element> Picker Object
show <!> picker is shown
hide <!> picker is hidden
options <o> Options object
element <o|null> picker element
elementHeight <n|128> height
elemementWidth <n|256> width
id <s> picker id
overlap <s|none> select button overlap value
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Picker Object
show <!> picker is shown
hide <!> picker is hidden
@*/
Ox.Picker = function(options, self) {

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

@ -2,11 +2,11 @@
/*@
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
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.FormElementGroup> PlaceInput Object
@*/
Ox.PlaceInput = function(options, self) {

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

@ -2,11 +2,11 @@
/*@
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
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Picker> PlacePicker Object
@*/
Ox.PlacePicker = function(options, self) {

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

@ -2,8 +2,6 @@
/*@
Ox.Range <f> Range Object
([options[, self]]) -> <o:Ox.Element> Range Object
change <!> triggered on change of the range
options <o> Options object
arrows <b> if true, show arrows
arrowStep <n> step when clicking arrows
@ -22,7 +20,9 @@ Ox.Range <f> Range Object
trackStep <n> 0 (scroll here) or step when clicking track
value <n> initial value
values <[s]> values to display on thumb
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Range Object
change <!> triggered on change of the range
@*/
Ox.Range = function(options, self) {

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

@ -2,9 +2,6 @@
/*@
Ox.Select <f> Select Object
([options[, self]) -> <o:Ox.Element> Select Object
click <!> Click event
change <!> Change event
options <o> Options object
disabled <b|false> If true, select is disabled
id <s> Element id
@ -26,6 +23,9 @@ Ox.Select <f> Select Object
value <a|s> Selected id, or array of selected ids
width <s|n|'auto'> Width in px, or 'auto'
self <o> Shared private variable
([options[, self]) -> <o:Ox.Element> Select Object
click <!> Click event
change <!> Change event
@*/
Ox.Select = function(options, self) {

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

@ -2,9 +2,9 @@
//FIXME: does not work without options
/*@
Ox.SelectInput <f> Select Input
([options[, self]]) -> <o:Ox.FormElementGroup> Select Input
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.FormElementGroup> Select Input
@*/
Ox.SelectInput = function(options, self) {

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

@ -2,10 +2,10 @@
/*@
Ox.Spreadsheet <f> Spreadsheet
([options[, self]]) -> <o:Ox.Element> Spreadsheet
change <!> change
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Spreadsheet
change <!> change
@*/
Ox.Spreadsheet = function(options, self) {

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

@ -2,13 +2,13 @@
/*@
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
milliseconds <b|false> show milliseconds
value <d> value, defaults to current time
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.InputGroup> TimeInput Object
@*/
Ox.TimeInput = function(options, self) {