update widget documentation (arguments first)

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

View file

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

View file

@ -2,12 +2,6 @@
/*@ /*@
Ox.Progressbar <f> Progress Bar 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 options <o|{}> Options object
cancelled <b|false> If true, progress bar is cancelled cancelled <b|false> If true, progress bar is cancelled
paused <b|false> If true, progress bar is paused 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 showTooltips <b|false> If true, buttons have tooltips
width <n|256> Width in px width <n|256> Width in px
self <o|{}> Shared private variable 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) { Ox.Progressbar = function(options, self) {

View file

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

View file

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

View file

@ -2,12 +2,6 @@
/*@ /*@
Ox.DocPanel <f> Documentation Panel 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 options <o> Options object
collapsible <b|false> If true, the list can be collabsed collapsible <b|false> If true, the list can be collabsed
element <e> Default content element <e> Default content
@ -29,6 +23,12 @@ Ox.DocPanel <f> Documentation Panel
size <s|256> Default list size size <s|256> Default list size
stripComments <b|false> If true, strip comments in source code stripComments <b|false> If true, strip comments in source code
self <o> Shared private variable 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) { Ox.DocPanel = function(options, self) {

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.ArrayInput <f> Array input Ox.ArrayInput <f> Array input
([options[, self]]) -> <o:Ox.Element> Array input
options <o> Options object options <o> Options object
label <s> string, '' label <s> string, ''
max <n> integer, maximum number of items, 0 for all max <n> integer, maximum number of items, 0 for all
@ -10,7 +9,8 @@ Ox.ArrayInput <f> Array input
value <[]> value value <[]> value
width <n|256> width width <n|256> width
self <o> Shared private variable self <o> Shared private variable
change <!> change ([options[, self]]) -> <o:Ox.Element> Array input
change <!> change
@*/ @*/
Ox.ArrayInput = function(options, self) { Ox.ArrayInput = function(options, self) {

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.Button <f> Button Object Ox.Button <f> Button Object
([options[, self]]) -> <o:Ox.Element> Button Object
options <o> Options object options <o> Options object
If a button is both selectable and has two values, its value is the 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 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}] values <[o]|[]> [{id, title}, {id, title}]
width <s|'auto'> Button width width <s|'auto'> Button width
self <o> Shared private variable self <o> Shared private variable
click <!> non-selectable button was clicked ([options[, self]]) -> <o:Ox.Element> Button Object
change <!> selectable button was clicked click <!> non-selectable button was clicked
change <!> selectable button was clicked
@*/ @*/
Ox.Button = function(options, self) { Ox.Button = function(options, self) {

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.ButtonGroup <f> ButtonGroup Object Ox.ButtonGroup <f> ButtonGroup Object
([options[, self]]) -> <o:Ox.Element> ButtonGroup Object
options <o> Options object options <o> Options object
buttons <[o]> array of button options buttons <[o]> array of button options
max <n> integer, maximum number of selected buttons, 0 for all 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 selectable <b> if true, buttons are selectable
type <s> string, 'image' or 'text' type <s> string, 'image' or 'text'
self <o> Shared private variable 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) { Ox.ButtonGroup = function(options, self) {

View file

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

View file

@ -2,16 +2,16 @@
/*@ /*@
Ox.CheckboxGroup <f> CheckboxGroup Object 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 options <o> Options object
checkboxes <a|[]> array of checkboxes checkboxes <a|[]> array of checkboxes
max <n|1> max selected max <n|1> max selected
min <n|1> min selected min <n|1> min selected
type <s|"group"> type ("group" or "list") type <s|"group"> type ("group" or "list")
width <n> width in px 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) { Ox.CheckboxGroup = function(options, self) {

View file

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

View file

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

View file

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

View file

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

View file

@ -2,18 +2,18 @@
/*@ /*@
Ox.Editable <f> Editable element 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 options <o> Options object
editing <b|false> If true, loads in editing state editing <b|false> If true, loads in editing state
format <f|null> Format function format <f|null> Format function
(value) -> <s> Formatted value (value) -> <s> Formatted value
value <s> Input value value <s> Input value
self <o> Shared private variable 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) { Ox.Editable = function(options, self) {

View file

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

View file

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

View file

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

View file

@ -2,11 +2,11 @@
/*@ /*@
Ox.FormItem <f> FormItem Element, wraps form element with an error message Ox.FormItem <f> FormItem Element, wraps form element with an error message
([options[, self]]) -> <o:Ox.Element> FormItem Element
options <o> Options object options <o> Options object
element <o|null> element element <o|null> element
error <s> error message error <s> error message
self <o> Shared private variable self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> FormItem Element
@*/ @*/
Ox.FormItem = function(options, self) { Ox.FormItem = function(options, self) {

View file

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

View file

@ -2,17 +2,6 @@
/*@ /*@
Ox.Input <f> Input Element 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 options <o> Options object
arrows <b> if true, and type is 'float' or 'int', display arrows arrows <b> if true, and type is 'float' or 'int', display arrows
arrowStep <n> step when clicking arrows arrowStep <n> step when clicking arrows
@ -65,7 +54,17 @@ Ox.Input <f> Input Element
value <s> string value <s> string
validate <f> remote validation validate <f> remote validation
width <n> px 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) { Ox.Input = function(options, self) {

View file

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

View file

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

View file

@ -2,8 +2,9 @@
/*@ /*@
Ox.Label <f> Label element Ox.Label <f> Label element
options <o|u> Options object
self <o|u> Shared private variable
([options[, self]]) -> <o:Ox.Element> Label element ([options[, self]]) -> <o:Ox.Element> Label element
options <o> Options object
@*/ @*/
Ox.Label = function(options, self) { Ox.Label = function(options, self) {

View file

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

View file

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

View file

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

View file

@ -2,11 +2,11 @@
/*@ /*@
Ox.PlaceInput <f> PlaceInput Object Ox.PlaceInput <f> PlaceInput Object
([options[, self]]) -> <o:Ox.FormElementGroup> PlaceInput Object
options <o> Options object options <o> Options object
id <s> element id id <s> element id
value <s|United States> default value of place input 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) { Ox.PlaceInput = function(options, self) {

View file

@ -2,11 +2,11 @@
/*@ /*@
Ox.PlacePicker <f> PlacePicker Object Ox.PlacePicker <f> PlacePicker Object
([options[, self]]) -> <o:Ox.Picker> PlacePicker Object
options <o> Options object options <o> Options object
id <s> element id id <s> element id
value <s|United States> default value of place input 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) { Ox.PlacePicker = function(options, self) {

View file

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

View file

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

View file

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

View file

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

View file

@ -2,13 +2,13 @@
/*@ /*@
Ox.TimeInput <f> TimeInput Object Ox.TimeInput <f> TimeInput Object
([options[, self]]) -> <o:Ox.InputGroup> TimeInput Object
options <o> Options object options <o> Options object
ampm <b|false> 24h/ampm ampm <b|false> 24h/ampm
seconds <b|false> show seconds seconds <b|false> show seconds
milliseconds <b|false> show milliseconds milliseconds <b|false> show milliseconds
value <d> value, defaults to current time 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) { Ox.TimeInput = function(options, self) {

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.Chart <f> Bar Chart Ox.Chart <f> Bar Chart
([options[, self]]) -> <o:Ox.Element> Chart object
options <o> Options options <o> Options
color <[n]|[[n]]|[128, 128, 128]> Bar color color <[n]|[[n]]|[128, 128, 128]> Bar color
data <o> {k: v, ...} or {k: {k: v, ...}, ...} data <o> {k: v, ...} or {k: {k: v, ...}, ...}
@ -14,7 +13,7 @@ Ox.Chart <f> Bar Chart
title <s|''> Chart title title <s|''> Chart title
width <n|512> Chart width width <n|512> Chart width
self <o> shared private variable self <o> shared private variable
([options[, self]]) -> <o:Ox.Element> Chart object
@*/ @*/
Ox.Chart = function(options, self) { Ox.Chart = function(options, self) {

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.IconItem <f> IconItem Object Ox.IconItem <f> IconItem Object
([options[, self]]) -> <o:Ox.Element> IconItem Object
options <o> Options object options <o> Options object
borderRadius <n|0> Border radius for icon images borderRadius <n|0> Border radius for icon images
find <s|''> String to be highlighted find <s|''> String to be highlighted
@ -16,6 +15,7 @@ Ox.IconItem <f> IconItem Object
title <s> Title title <s> Title
url <s> Icon url url <s> Icon url
self <o> Shared private variable self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> IconItem Object
@*/ @*/
Ox.IconItem = function(options, self) { Ox.IconItem = function(options, self) {

View file

@ -1,7 +1,6 @@
'use strict'; 'use strict';
/*@ /*@
Ox.IconList <f> IconList Object Ox.IconList <f> IconList Object
([options[, self]]) -> <o:Ox.List> IconList Object
options <o> Options object options <o> Options object
borderRadius <n|0> border radius for icon images borderRadius <n|0> border radius for icon images
centerSelection <b|false> scroll list so selection is always centered 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 selected <a|[]> array of selected items
size <n|128> list size size <n|128> list size
sort <a|[]> sort keys 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) { Ox.IconList = function(options, self) {

View file

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

View file

@ -2,16 +2,16 @@
/*@ /*@
Ox.ListItem <f> ListItem Object 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 options <o> Options object
construct <f> construct function construct <f> construct function
data <o|{}> item data data <o|{}> item data
draggable <b|false> can be dragged draggable <b|false> can be dragged
position <n|0> item position position <n|0> item position
unique <s|''> unique key 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) { Ox.ListItem = function(options, self) {

View file

@ -2,9 +2,9 @@
/*@ /*@
Ox.ListPage <f> ListPage Object Ox.ListPage <f> ListPage Object
([options[, self]]) -> <o:Ox.Element> ListPage Object
options <o> Options 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) { Ox.ListPage = function(options, self) {
self = self || {}; self = self || {};

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.TableList <f> TableList Widget Ox.TableList <f> TableList Widget
([options[, self]]) -> <o:Ox.Element> TableList Object
options <o> Options object options <o> Options object
columns <[o]|[]> Columns columns <[o]|[]> Columns
# Fixme: There's probably more... # Fixme: There's probably more...
@ -42,7 +41,8 @@ Ox.TableList <f> TableList Widget
deprecated). deprecated).
columnresize <!> columnresize columnresize <!> columnresize
columnchange <!> columnchange 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. // fixme: options.columnsMovable, but options.sortable ... pick one.

View file

@ -2,7 +2,6 @@
/*@ /*@
Ox.TreeList <f> Tree List Ox.TreeList <f> Tree List
([options[, self]]) -> <o:Ox.List> Tree List Object
options <o> Options object options <o> Options object
data <f|null> Data to be parsed as items (needs documentation) 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 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 selected <a|[]> Selected ids
width <n|256> List width width <n|256> List width
self <o> Shared private variable self <o> Shared private variable
([options[, self]]) -> <o:Ox.List> Tree List Object
@*/ @*/
Ox.TreeList = function(options, self) { Ox.TreeList = function(options, self) {

View file

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

View file

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

View file

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

View file

@ -2,17 +2,6 @@
/*@ /*@
Ox.Menu <f> Menu Object 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 options <o> Options object
element <o> the element the menu is attached to element <o> the element the menu is attached to
id <s> the menu id id <s> the menu id
@ -25,7 +14,18 @@ Ox.Menu <f> Menu Object
selected <b> the position of the selected item selected <b> the position of the selected item
side <s> open to 'bottom' or 'right' side <s> open to 'bottom' or 'right'
size <s> 'large', 'medium' or 'small' 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) { Ox.Menu = function(options, self) {

View file

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

View file

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

View file

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

View file

@ -2,11 +2,6 @@
/*@ /*@
Ox.SplitPanel <f> SpliPanel Object 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 options <o> Options object
elements <[o]|[]> Array of two or three element objects elements <[o]|[]> Array of two or three element objects
collapsible <b|false> If true, can be collapsed (if outer element) 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") size <n|s|"auto"> Size in px (one element must be "auto")
tooltip <b|s|false> If true, show tooltip, if string, append it tooltip <b|s|false> If true, show tooltip, if string, append it
orientation <s|"horizontal"> orientation ("horizontal" or "vertical") 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) { Ox.SplitPanel = function(options, self) {

View file

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

View file

@ -2,6 +2,14 @@
/*@ /*@
Ox.AnnotationFolder <f> AnnotationFolder Object 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 ([options[, self]]) -> <o:Ox.CollapsePanel> AnnotationFolder Object
add <!> add add <!> add
blur <!> blur blur <!> blur
@ -19,14 +27,6 @@ Ox.AnnotationFolder <f> AnnotationFolder Object
submit <!> submit submit <!> submit
togglelayer <!> togglelayer togglelayer <!> togglelayer
togglewidget <!> togglewidget 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) { Ox.AnnotationFolder = function(options, self) {

View file

@ -2,23 +2,6 @@
/*@ /*@
Ox.AnnotationPanel <f> Video Annotation Panel 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 options <o> Options object
calendarSize <n|256> calendar size calendarSize <n|256> calendar size
clickLink <f|null> click link callback clickLink <f|null> click link callback
@ -36,7 +19,24 @@ Ox.AnnotationPanel <f> Video Annotation Panel
showUsers <b|false> if true show user showUsers <b|false> if true show user
sort <s|'position'> position, start, text sort <s|'position'> position, start, text
width <n|256> panel width 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) { Ox.AnnotationPanel = function(options, self) {

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -2,28 +2,6 @@
/*@ /*@
Ox.VideoPlayer <f> Generic Video Player 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 options <o> Options
annotations <[]> Array of annotations annotations <[]> Array of annotations
id <s> Optional id id <s> Optional id
@ -95,6 +73,28 @@ Ox.VideoPlayer <f> Generic Video Player
volume <n|1> Volume (0-1) volume <n|1> Volume (0-1)
width <n|256> Width in px width <n|256> Width in px
self <o> shared private variable 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) { Ox.VideoPlayer = function(options, self) {

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -2,10 +2,10 @@
/*@ /*@
Ox.Tooltip <f> Tooltip Object Ox.Tooltip <f> Tooltip Object
([options[, self]]) -> <o:Ox.Element> Tooltip Object
options <o> Options 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) { Ox.Tooltip = function(options, self) {