0x2620/oxjs
2
0
Fork 1
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
parent daec992536
commit a0867f0da6
81 changed files with 250 additions and 251 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
source/Ox.UI/js/Bar/Bar.js
View file

@ -1,11 +1,11 @@
'use strict';
/*@
Ox.Bar <f> Bar
([options[, self]]) -> <o:Ox.Element> Bar object
options <o> Options object
orientation <s|'horizontal'> Orientation ('horizontal' or 'vertical')
size <n|s|'medium'> can be 'small', 'medium', 'large' or number
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Bar object
@*/
Ox.Bar = function(options, self) {
self = self || {};

12
source/Ox.UI/js/Bar/Progressbar.js
View file

@ -2,12 +2,6 @@
/*@
Ox.Progressbar <f> Progress Bar
([options[, self]]) -> <o:Ox.Element> Progress Bar
cancel <!> cancelled
complete <!> completed
pause <!> paused
restart <!> restart
resume <!> resumed
options <o|{}> Options object
cancelled <b|false> If true, progress bar is cancelled
paused <b|false> If true, progress bar is paused
@ -20,6 +14,12 @@ Ox.Progressbar <f> Progress Bar
showTooltips <b|false> If true, buttons have tooltips
width <n|256> Width in px
self <o|{}> Shared private variable
([options[, self]]) -> <o:Ox.Element> Progress Bar
cancel <!> cancelled
complete <!> completed
pause <!> paused
restart <!> restart
resume <!> resumed
@*/
Ox.Progressbar = function(options, self) {

2
source/Ox.UI/js/Bar/Resizebar.js
View file

@ -1,7 +1,6 @@
'use strict';
/*@
Ox.Resizebar <f> Resizebar
([options[, self]]) -> <o:Ox.Element> Resizebar object
options <o> Options object
collapsed <b|false> inital collapse state
collapsible <b|true> collapse state can be changed
@ -14,6 +13,7 @@ Ox.Resizebar <f> Resizebar
size <n|0> default size
tooltip <b|s|false> tooltip or not
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Resizebar object
@*/
Ox.Resizebar = function(options, self) {

2
source/Ox.UI/js/Bar/Tabbar.js
View file

@ -1,11 +1,11 @@
'use strict';
/*@
Ox.Tabbar <f> Tabbar
([options[, self]]) -> <o:Ox.Bar> Tabbar object
options <o> Options object
selected <n|0> selected item
tabs <a|[]> tabs
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Bar> Tabbar object
@*/
Ox.Tabbar = function(options, self) {

12
source/Ox.UI/js/Code/DocPanel.js
View file

@ -2,12 +2,6 @@
/*@
Ox.DocPanel <f> Documentation Panel
([options[, self]]) -> <o:Ox.SplitPanel> Documentation Panel
load <!> Fires once all docs are loaded
items [o] Array of doc items
tests <!> Fires once all tests finished
results [o] Array of results
select <!> select
options <o> Options object
collapsible <b|false> If true, the list can be collabsed
element <e> Default content
@ -29,6 +23,12 @@ Ox.DocPanel <f> Documentation Panel
size <s|256> Default list size
stripComments <b|false> If true, strip comments in source code
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> Documentation Panel
load <!> Fires once all docs are loaded
items [o] Array of doc items
tests <!> Fires once all tests finished
results [o] Array of results
select <!> select
@*/
Ox.DocPanel = function(options, self) {

2
source/Ox.UI/js/Code/ExamplePage.js
View file

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

4
source/Ox.UI/js/Code/ExamplePanel.js
View file

@ -2,12 +2,12 @@
/*@
Ox.ExamplePanel <f> Example Panel
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> Example Panel
load <!> load
select <!> select
id <s> selected example
options <o> Options
self <o> Shared private variable
@*/
Ox.ExamplePanel = function(options, self) {

2
source/Ox.UI/js/Code/SourceViewer.js
View file

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

2
source/Ox.UI/js/Code/SyntaxHighlighter.js
View file

@ -2,7 +2,6 @@
/*@
Ox.SyntaxHighlighter <f> Syntax Highlighter
([options[, self]]) -> <o:Ox.Element> Syntax Highlighter
options <o> Options
file <s|''> JavaScript file (alternative to `source` option)
lineLength <n|0> If larger than zero, show edge of page
@ -18,6 +17,7 @@ Ox.SyntaxHighlighter <f> Syntax Highlighter
stripComments <b|false> If true, strip comments
tabSize <n|4> Number of spaces per tab
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Syntax Highlighter
@*/
Ox.SyntaxHighlighter = function(options, self) {

4
source/Ox.UI/js/Core/App.js
View file

@ -2,13 +2,13 @@
/*@
Ox.App <f> Basic application instance that communicates with a JSON API
([options]) -> <o> App object
load <!> App loaded
options <o> Options object
name <s> App name
timeout <n> Request timeout
type <s> HTTP Request type, i.e. 'GET' or 'POST'
url <s> JSON API URL
([options]) -> <o> App object
load <!> App loaded
@*/
Ox.App = function(options) {

2
source/Ox.UI/js/Core/Container.js
View file

@ -6,9 +6,9 @@
// would append (length - 1)?
/*@
Ox.Container <f> Container element
([options[, self]]) -> <o:Ox.Element> Container object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Container object
@*/
Ox.Container = function(options, self) {
var that = Ox.Element({}, self)

2
source/Ox.UI/js/Core/Event.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.Event <o> Used internally for events
Ox.Event <o> Event controller
@*/
Ox.Event = (function() {

2
source/Ox.UI/js/Core/Focus.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.Focus <o> Basic focus handler
Ox.Focus <o> Basic focus controller
@*/
Ox.Focus = (function() {

2
source/Ox.UI/js/Core/JQueryElement.js
View file

@ -2,8 +2,8 @@
/*@
Ox.JQueryElement <f> Wrapper for jQuery
($element) -> <o> Wrapped jQuery DOM element
$element <o> jQuery DOM Element
($element) -> <o> Wrapped jQuery DOM element
@*/
Ox.JQueryElement = function($element) {
//@ id <n> Unique id

2
source/Ox.UI/js/Core/Keyboard.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.Keyboard <o> Basic keyboard handler
Ox.Keyboard <o> Basic keyboard controller
@*/
Ox.Keyboard = (function() {

2
source/Ox.UI/js/Core/LoadingIcon.js
View file

@ -2,10 +2,10 @@
/*@
Ox.LoadingIcon <f> Loading Icon Element
([options[, self]]) -> <o:Ox.Element> Loading Icon Element
options <o> Options object
size <n|s|16> size of icon
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Loading Icon Element
@*/
Ox.LoadingIcon = function(options, self) {

17
source/Ox.UI/js/Core/Request.js
View file

@ -1,12 +1,12 @@
'use strict';
/*@
Ox.Request <o> Basic request handler object
FIXME: options is not a property, just documenting defaults
options <o> Options object
timeout <n|60000> request timeout
type <s|"POST"> request type, possible values POST, GET, PUT, DELETE
url <s> request url
Ox.Request <o> Basic request controller
# FIXME: options is not a property, just documenting defaults
# options <o> Options object
# timeout <n|60000> request timeout
# type <s|"POST"> request type, possible values POST, GET, PUT, DELETE
# url <s> request url
@*/
Ox.Request = (function() {
@ -74,11 +74,6 @@ Ox.Request = (function() {
$element.bindEvent.apply(this, arguments);
},
// fixme: remove
_leakCache: function() {
return cache;
},
/*@
options <f> get/set options
() -> <o> get options

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) {

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) {

10
source/Ox.UI/js/Map/MapEditor.js
View file

@ -2,11 +2,6 @@
/*@
Ox.MapEditor <f> Map Editor
([options[, self]]) -> <o:Ox.SplitPanel> Map Editor
addplace <!> addplace
removeplace <!> removeplace
geocode <!> geocode
loadlist <!> loadlist
options <o> Options object
height <n|256> Height in px
labels <b|false> If true, show labels
@ -15,6 +10,11 @@ Ox.MapEditor <f> Map Editor
selected <s|''> Id of the selected place
width <n|256> Width in px
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> Map Editor
addplace <!> addplace
removeplace <!> removeplace
geocode <!> geocode
loadlist <!> loadlist
@*/
Ox.MapEditor = function(options, self) {

2
source/Ox.UI/js/Map/MapImage.js
View file

@ -2,13 +2,13 @@
/*@
Ox.MapImage <f> MapImage Object
([options[, self]]) -> <o:Ox.Element> MapImage Object
options <o> Options object
height <n|360> image height (px)
place <o|null> Object with south, west, north and east properties
type <s|satellite> map type ('hybrid', 'roadmap', 'satellite', 'terrain')
width <n|640> image width (px)
self <o> shared private variable
([options[, self]]) -> <o:Ox.Element> MapImage Object
@*/
Ox.MapImage = function(options, self) {

4
source/Ox.UI/js/Menu/MainMenu.js
View file

@ -2,12 +2,12 @@
/*@
Ox.MainMenu <f> MainMenu Object
([options[, self]]) -> <o:Ox.Bar> MainMenu Object
options <o> Options object
extras <a|[]> extra menus
menus <a|[]> submenus
size <s|medium> can be small, medium, large
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Bar> MainMenu Object
@*/
Ox.MainMenu = function(options, self) {

24
source/Ox.UI/js/Menu/Menu.js
View file

@ -2,17 +2,6 @@
/*@
Ox.Menu <f> Menu Object
([options[, self]]) -> <o:Ox.Element> Menu Object
change_groupId <!> {id, value} checked item of a group has changed
click_itemId <!> item not belonging to a group was clicked
click_menuId <!> {id, value} item not belonging to a group was clicked
deselect_menuId <!> {id, value} item was deselected not needed, not implemented
hide_menuId <!> menu was hidden
select_menuId <!> {id, value} item was selected
click <!> click
change <!> change
select <!> select
deselect <!> deselect
options <o> Options object
element <o> the element the menu is attached to
id <s> the menu id
@ -25,7 +14,18 @@ Ox.Menu <f> Menu Object
selected <b> the position of the selected item
side <s> open to 'bottom' or 'right'
size <s> 'large', 'medium' or 'small'
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Menu Object
change_groupId <!> {id, value} checked item of a group has changed
click_itemId <!> item not belonging to a group was clicked
click_menuId <!> {id, value} item not belonging to a group was clicked
deselect_menuId <!> {id, value} item was deselected not needed, not implemented
hide_menuId <!> menu was hidden
select_menuId <!> {id, value} item was selected
click <!> click
change <!> change
select <!> select
deselect <!> deselect
@*/
Ox.Menu = function(options, self) {

3
source/Ox.UI/js/Menu/MenuButton.js
View file

@ -2,7 +2,6 @@
/*@
Ox.MenuButton <f> Menu Button
([options[, self]]) -> <o:Ox.Element> Menu Button
options <o> Options object
disabled <b|false> If true, button is disabled
id <s|''> Element id
@ -19,6 +18,8 @@ Ox.MenuButton <f> Menu Button
change <!> change
hide <!> hide
show <!> show
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Menu Button
@*/
Ox.MenuButton = function(options, self) {

4
source/Ox.UI/js/Menu/MenuItem.js
View file

@ -2,7 +2,6 @@
/*@
Ox.MenuItem <f> MenuItem Object
([options[, self]]) -> <o:Ox.Element> MenuItem Object
options <o> Options object
bind <a|[]> fixme: what's this?
checked <f|null> If true, the item is checked
@ -16,7 +15,8 @@ Ox.MenuItem <f> MenuItem Object
menu <o|null> menu
position <n|0> position
title <a|[]> title
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> MenuItem Object
@*/
Ox.MenuItem = function(options, self) {

6
source/Ox.UI/js/Panel/CollapsePanel.js
View file

@ -2,14 +2,14 @@
/*@
Ox.CollapsePanel <f> CollapsePanel Object
([options[, self]]) -> <o:Ox.Element> CollapsePanel Object
toggle <!> toggle
options <o> Options object
collapsed <b|false> collapsed state
extras <a|[]> panel extras
size <n|16> size
title <s> title
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> CollapsePanel Object
toggle <!> toggle
@*/
Ox.CollapsePanel = function(options, self) {

12
source/Ox.UI/js/Panel/SplitPanel.js
View file

@ -2,11 +2,6 @@
/*@
Ox.SplitPanel <f> SpliPanel Object
([options[, self]]) -> <o:Ox.Element> SpliPanel Object
resize <!> resize
Fires on resize, on both elements being resized
toggle <!> toggle
Fires on collapse or expand, on the element being toggled
options <o> Options object
elements <[o]|[]> Array of two or three element objects
collapsible <b|false> If true, can be collapsed (if outer element)
@ -19,7 +14,12 @@ Ox.SplitPanel <f> SpliPanel Object
size <n|s|"auto"> Size in px (one element must be "auto")
tooltip <b|s|false> If true, show tooltip, if string, append it
orientation <s|"horizontal"> orientation ("horizontal" or "vertical")
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> SpliPanel Object
resize <!> resize
Fires on resize, on both elements being resized
toggle <!> toggle
Fires on collapse or expand, on the element being toggled
@*/
Ox.SplitPanel = function(options, self) {

4
source/Ox.UI/js/Panel/TabPanel.js
View file

@ -2,8 +2,6 @@
/*@
Ox.TabPanel <f> Tabbed panel
([options[, self]]) -> <o:Ox.SplitPanel> Panel
change <!> change
options <o> Options
content <o|f> Content per tab
Either `({id1: $element1, id2: $element2}}` or `function(id) {
@ -13,6 +11,8 @@ Ox.TabPanel <f> Tabbed panel
id <s> Tab id
title <s> Tab title
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> Panel
change <!> change
@*/
Ox.TabPanel = function(options, self) {

16
source/Ox.UI/js/Video/AnnotationFolder.js
View file

@ -2,6 +2,14 @@
/*@
Ox.AnnotationFolder <f> AnnotationFolder Object
options <o> Options object
editable <b|false> If true, annotations can be added
id <s> id
items <a|[]> items
title <s> title
type <s|'text'> panel type
width <n|0>
self <o> Shared private variable
([options[, self]]) -> <o:Ox.CollapsePanel> AnnotationFolder Object
add <!> add
blur <!> blur
@ -19,14 +27,6 @@ Ox.AnnotationFolder <f> AnnotationFolder Object
submit <!> submit
togglelayer <!> togglelayer
togglewidget <!> togglewidget
options <o> Options object
editable <b|false> If true, annotations can be added
id <s> id
items <a|[]> items
title <s> title
type <s|'text'> panel type
width <n|0>
self <o> shared private variable
@*/
Ox.AnnotationFolder = function(options, self) {

36
source/Ox.UI/js/Video/AnnotationPanel.js
View file

@ -2,23 +2,6 @@
/*@
Ox.AnnotationPanel <f> Video Annotation Panel
([options[, self]]) -> <o:Ox.SplitPanel> AnnotationPanel Object
add <!> add
annotationsID <!> annotationsID
blur <!> blur
change <!> change
define <!> define
edit <!> edit
findannotations <!> findannotations
find <!> find
focus <!> focus
info <!> info
open <!> open
remove <!> remove
resize <!> resize
submit <!> submit
togglelayer <!> togglelayer
toggle* <!> toggle*
options <o> Options object
calendarSize <n|256> calendar size
clickLink <f|null> click link callback
@ -36,7 +19,24 @@ Ox.AnnotationPanel <f> Video Annotation Panel
showUsers <b|false> if true show user
sort <s|'position'> position, start, text
width <n|256> panel width
self <o> shared private variable
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> AnnotationPanel Object
add <!> add
annotationsID <!> annotationsID
blur <!> blur
change <!> change
define <!> define
edit <!> edit
findannotations <!> findannotations
find <!> find
focus <!> focus
info <!> info
open <!> open
remove <!> remove
resize <!> resize
submit <!> submit
togglelayer <!> togglelayer
toggle* <!> toggle*
@*/
Ox.AnnotationPanel = function(options, self) {

4
source/Ox.UI/js/Video/BlockVideoTimeline.js
View file

@ -2,12 +2,12 @@
/*@
Ox.BlockVideoTimeline <f> Block Video Timeline
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Block Video Timeline
edit <!> edit
select <!> select
position <!> position
options <o> Options
self <o> Shared private variable
@*/
Ox.BlockVideoTimeline = function(options, self) {

6
source/Ox.UI/js/Video/LargeVideoTimeline.js
View file

@ -2,10 +2,10 @@
/*@
Ox.LargeVideoTimeline <f> LargeTimeline Object
([options[, self]]) -> <o:Ox.Element> LargeTimeline Object
options <o> Options object
self <o> shared private variable
position <!> position
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> LargeTimeline Object
position <!> position
@*/
Ox.LargeVideoTimeline = function(options, self) {

2
source/Ox.UI/js/Video/SmallVideoTimeline.js
View file

@ -2,6 +2,8 @@
/*@
Ox.SmallVideoTimeline <f> Small video timeline
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Small video timeline
position <!> position
@*/

2
source/Ox.UI/js/Video/SmallVideoTimelineImage.js
View file

@ -2,9 +2,9 @@
/*@
Ox.SmallVideoTimelineImage <f> Small Video Timeline Image
(options[, self]) -> <o:Ox.Element> Small Video Timeline Image
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Small Video Timeline Image
@*/
Ox.SmallVideoTimelineImage = function(options, self) {

5
source/Ox.UI/js/Video/VideoEditor.js
View file

@ -2,6 +2,8 @@
/*@
Ox.VideoEditor <f> VideoEditor Object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> VideoEditor Object
addannotation <!> addannotation
annotationsfont <!> annotationsfont
@ -37,9 +39,6 @@ Ox.VideoEditor <f> VideoEditor Object
togglelayer <!> togglelayer
togglemap <!> togglemap
volume <!> volume
options <o> Options object
annotationsCalendarSize <n|256>
self <o> shared private variable
@*/
// fixme: should be VideoAnnotationEditor

4
source/Ox.UI/js/Video/VideoEditorPlayer.js
View file

@ -2,13 +2,13 @@
/*@
Ox.VideoEditorPlayer <f> VideoEditorPlayer Object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> VideoEditorPlayer Object
change <!> change
playing <!> playing
set <!> set
togglesize <!> togglesize
options <o> Options object
self <o> shared private variable
@*/
Ox.VideoEditorPlayer = function(options, self) {

4
source/Ox.UI/js/Video/VideoElement.js
View file

@ -2,6 +2,8 @@
/*@
Ox.VideoElement <f> VideoElement Object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> VideoElement Object
loadedmetadata <!> loadedmetadata
pointschange <!> pointschange
@ -9,8 +11,6 @@ Ox.VideoElement <f> VideoElement Object
seeking <!> seeking
sizechange <!> sizechange
ended <!> ended
options <o> Options object
self <o> shared private variable
@*/
Ox.VideoElement = function(options, self) {

16
source/Ox.UI/js/Video/VideoPanel.js
View file

@ -2,7 +2,15 @@
/*@
Ox.VideoPanel <f> VideoPanel Object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> VideoPanel Object
annotationsfont <!> annotationsfont
annotationsrange <!> annotationsrange
annotationssize <!> annotationssize
annotationssort <!> annotationssort
censored <!> censored
downloadvideo <!> downloadvideo
find <!> find
info <!> info
key_* <!> key_*
@ -20,14 +28,6 @@ Ox.VideoPanel <f> VideoPanel Object
togglemap <!> togglemap
toggletimeline <!> toggletimeline
volume <!> volume
options <o> Options object
self <o> shared private variable
annotationsfont <!> annotationsfont
annotationsrange <!> annotationsrange
annotationssize <!> annotationssize
annotationssort <!> annotationssort
censored <!> censored
downloadvideo <!> downloadvideo
@*/
Ox.VideoPanel = function(options, self) {

44
source/Ox.UI/js/Video/VideoPlayer.js
View file

@ -2,28 +2,6 @@
/*@
Ox.VideoPlayer <f> Generic Video Player
([options[, self]]) -> <o:Ox.Element> Video Player
censored <!> censored
close <!> close
download <!> download
ended <!> ended
find <!> find
fullscreen <!> fullscreen
gotopoint <!> gotopoint
loadedmetadata <!> loadedmetadata
muted <!> muted
open <!> open
paused <!> paused
playing <!> playing
position <!> position
resolution <!> resolution
scale <!> scale
select <!> select
setpoint <!> setpoint
size <!> size
subtitles <!> subtitles
volume <!> volume
zap <!> zap
options <o> Options
annotations <[]> Array of annotations
id <s> Optional id
@ -95,6 +73,28 @@ Ox.VideoPlayer <f> Generic Video Player
volume <n|1> Volume (0-1)
width <n|256> Width in px
self <o> shared private variable
([options[, self]]) -> <o:Ox.Element> Video Player
censored <!> censored
close <!> close
download <!> download
ended <!> ended
find <!> find
fullscreen <!> fullscreen
gotopoint <!> gotopoint
loadedmetadata <!> loadedmetadata
muted <!> muted
open <!> open
paused <!> paused
playing <!> playing
position <!> position
resolution <!> resolution
scale <!> scale
select <!> select
setpoint <!> setpoint
size <!> size
subtitles <!> subtitles
volume <!> volume
zap <!> zap
@*/
Ox.VideoPlayer = function(options, self) {

4
source/Ox.UI/js/Video/VideoPreview.js
View file

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

2
source/Ox.UI/js/Video/VideoTimelinePanel.js
View file

@ -2,6 +2,8 @@
/*@
Ox.VideoTimelinePanel <f> Video timeline panel
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> Video timeline panel
annoationssize <!> annoationssize
annotationsfont <!> annotationsfont

4
source/Ox.UI/js/Video/VideoTimelinePlayer.js
View file

@ -2,6 +2,8 @@
/*@
Ox.VideoTimelinePlayer <f> Video Timeline Player
options <o> Options
self <o> Shared private variable
([options[, self]]) -> <o:Ox.SplitPanel> Video Timeline Player
censored <!> censored
follow <!> follow
@ -10,8 +12,6 @@ Ox.VideoTimelinePlayer <f> Video Timeline Player
position <!> position
timeline <!> timeline
volume <!> volume
options <o> Options
self <o> Shared private variable
@*/
Ox.VideoTimelinePlayer = function(options, self) {

4
source/Ox.UI/js/Window/Dialog.js
View file

@ -2,13 +2,13 @@
/*@
Ox.Dialog <f> Dialog object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Dialog object
close <!> close
open <!> open
resizeend <!> resizeend
resize <!> resize
options <o> Options object
self <o> Shared private variable
@*/
Ox.Dialog = function(options, self) {

4
source/Ox.UI/js/Window/Layer.js
View file

@ -2,11 +2,11 @@
/*@
Ox.Layer <f> Background layer for dialogs and menus
([options[, self]]) -> <o:Ox.Element> Layer
click <!> click
options <o> Options
type <s|'dialog'> Layer type ('dialog' or 'menu')
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Layer
click <!> click
@*/
Ox.Layer = function(options, self) {

6
source/Ox.UI/js/Window/Tooltip.js
View file

@ -2,10 +2,10 @@
/*@
Ox.Tooltip <f> Tooltip Object
([options[, self]]) -> <o:Ox.Element> Tooltip Object
options <o> Options object
self <o> shared private variable
@*/
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Tooltip Object
s@*/
Ox.Tooltip = function(options, self) {