0x2620/oxjs
2
0
Fork 1
Code Issues 172 Pull requests Releases Wiki Activity

update documentation (classes)

Browse source
This commit is contained in:
rolux 2012-05-31 12:32:54 +02:00
parent 684c4ceaf2
commit 8c347d9009
88 changed files with 177 additions and 227 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,12 +1,10 @@
'use strict';
/*@
Ox.Bar <f:Ox.Element> Bar
() -> <o> Bar object
(options) -> <o> Bar object
(options, self) -> <o> Bar object
Ox.Bar <f> Bar
([options[, self]]) -> <o:Ox.Element> Bar object
options <o> Options object
orientation <s|'horizontal'>
size <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
@*/
Ox.Bar = function(options, self) {

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.Progressbar <f:Ox.Element> Progress Bar
() -> <o> Progress Bar
(options) -> <o> Progress Bar
(options, self) -> <o> Progress Bar
Ox.Progressbar <f> Progress Bar
([options[, self]]) -> <o:Ox.Element> Progress Bar
options <o|{}> Options object
cancelled <b|false> If true, progress bar is cancelled
paused <b|false> If true, progress bar is paused

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

@ -1,9 +1,7 @@
'use strict';
/*@
Ox.Resizebar <f:Ox.Element> Resizebar
() -> <f> Resizebar object
(options) -> <f> Resizebar object
(options, self) -> <f> Resizebar object
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

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

@ -1,9 +1,7 @@
'use strict';
/*@
Ox.Tabbar <f:Ox.Bar> Tabbar
() -> <o> Tabbar object
(options) -> <o> Tabbar object
(options, self) -> <o> Tabbar object
Ox.Tabbar <f> Tabbar
([options[, self]]) -> <o:Ox.Bar> Tabbar object
options <o> Options object
selected <n|0> selected item
tabs <a|[]> tabs

6
source/Ox.UI/js/Calendar/Calendar.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.Calendar <f:Ox.Element> Basic calendar object
() -> <o> Calendar object
(options) -> <o> Calendar object
(options, self) -> <o> Calendar object
Ox.Calendar <f> Basic calendar object
([options[, self]]) -> <o:Ox.Element> Calendar object
options <o> Options object
date <d|new Date()> UTC Date on which the calendar is centered
events <[o]|[]> Event objects to be displayed

4
source/Ox.UI/js/Calendar/ListCalendar.js
View file

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

6
source/Ox.UI/js/Code/DocPage.js
View file

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.DocPage <f:Ox.Element> DocPage
() -> <o> DocPage object
(options) -> <o> DocPage object
(options, self) -> <o> DocPage object
Ox.DocPage <f> DocPage
([options[, self]]) -> <o:Ox.SplitPanel> DocPage object
options <o> Options object
item <o> doc item
replace <[[]]|[]> See Ox.SyntaxHighlighter

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.DocPanel <f:Ox.Element> Documentation Panel
() -> <f> Documentation Panel
(options) -> <f> Documentation Panel
(options, self) -> <f> Documentation Panel
Ox.DocPanel <f> Documentation Panel
([options[, self]]) -> <o:Ox.SplitPanel> Documentation Panel
options <o> Options object
collapsible <b|false> If true, the list can be collabsed
element <e> Default content

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

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

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

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

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

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

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.SyntaxHighlighter <f:Ox.Element> Syntax Highlighter
(options[, self]) -> <o> Syntax Highlighter
Ox.SyntaxHighlighter <f> Syntax Highlighter
([options[, self]]) -> <o:Ox.Element> Syntax Highlighter
options <o> Options
lineLength <n|0> If larger than zero, show edge of page
offset <n|1> First line number

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

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.App <f:Ox.Element> 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
options <o> Options object
timeout <n> request timeout

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

@ -5,10 +5,8 @@
// 0, 1, 2, etc, so that append would append 0, and appendTo
// would append (length - 1)?
/*@
Ox.Container <f:Ox.Element> Container element
() -> <o> Container object
(options) -> <o> Container object
(options, self) -> <o> Container object
Ox.Container <f> Container element
([options[, self]]) -> <o:Ox.Element> Container object
options <o> Options object
self <o> Shared private variable
@*/

9
source/Ox.UI/js/Core/Element.js
View file

@ -1,14 +1,11 @@
'use strict';
/*@
Ox.Element <f:Ox.JQueryElement> Basic UI element object
Ox.Element <function> Basic UI element object
# Usage --------------------------------------------------------------------
(element) -> <object> UI element
(options) -> <object> UI element
(options, self) -> <object> UI element
([options[, self]]) -> <object:Ox.JQueryElement> Element object
# Arguments ----------------------------------------------------------------
element <string> Tagname or CSS selector
options <object> Options of the element
options <object|string> Options of the element, or just `element` option
# Properties
element <string> Tagname or CSS selector
tooltip <string|function> Tooltip title, or a function that returns one

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.LoadingIcon <f:Ox.Element> Loading Icon Element
() -> <f> Loading Icon Element
(options) -> <f> Loading Icon Element
(options, self) -> <f> Loading Icon Element
Ox.LoadingIcon <f> Loading Icon Element
([options[, self]]) -> <o:Ox.Element> Loading Icon Element
options <o> Options object
size <s|medium> size of icon
self <o> Shared private variable

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4
source/Ox.UI/js/List/Chart.js vendored
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Chart <f:Ox.Element> Bar Chart
([options[, self]]) -> <o> Chart object
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, ...}, ...}

4
source/Ox.UI/js/List/IconItem.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.IconItem <f:Ox.Element> IconItem Object
([options[, self]]) -> <o> IconItem Object
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

4
source/Ox.UI/js/List/IconList.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.IconList <f:Ox.Element> IconList Object
([options[, self]]) -> <o> IconList Object
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

4
source/Ox.UI/js/List/InfoList.js
View file

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

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

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.List <f:Ox.Container> List constructor
Ox.List <f> List constructor
options <o> Options object
centered <b|false> if true, and orientation is 'horizontal', then keep the selected item centered
construct <f|null> (data) returns the list item HTML
@ -22,7 +22,7 @@ Ox.List <f:Ox.Container> List constructor
type <s|'text'> type
unique <s|''> name of the key that acts as unique id
self <o> shared private variable
([options[, self]]) -> <o> List object
([options[, self]]) -> <o:Ox.Container> List object
add <!> item added
delete <!> item removed
draganddrop <!> Fires during drag

4
source/Ox.UI/js/List/ListItem.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.ListItem <f:Ox.Element> ListItem Object
([options[, self]]) -> <o> ListItem Object
Ox.ListItem <f> ListItem Object
([options[, self]]) -> <o:Ox.Element> ListItem Object
options <o> Options object
construct <f> construct function
data <o|{}> item data

4
source/Ox.UI/js/List/ListPage.js
View file

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

4
source/Ox.UI/js/List/TextList.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.TextList <f:Ox.Element> TextList Object
([options[, self]]) -> <o> TextList Object
Ox.TextList <f> TextList Object
([options[, self]]) -> <o:Ox.Element> TextList Object
options <o> Options object
columns <[o]|[]> Columns
# Fixme: There's probably more...

4
source/Ox.UI/js/List/TreeList.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.TreeList <f:Ox.Element> TreeList Object
([options[, self]]) -> <o> TreeList Object
Ox.TreeList <f> TreeList Object
([options[, self]]) -> <o:Ox.List> TreeList Object
options <o> Options object
data <f|null> data to be parsed to items, needs documentation
items <a|[]> array of items

4
source/Ox.UI/js/Map/ListMap.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.ListMap <f:Ox.Element> ListMap object
([options[, self]]) -> <o> ListMap object
Ox.ListMap <f> ListMap object
([options[, self]]) -> <o:Ox.SplitPanel> ListMap object
options <o> Options object
height <n|256> Height in px
labels <b|false> If true, show labels

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.MapImage <f:Ox.Element> MapImage Object
([options[, self]]) -> <o> MapImage Object
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

4
source/Ox.UI/js/Map/MapMarker.js
View file

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.MapMarker <f> MapMarker Object
(options) -> <f> MapMarker Object
Ox.MapMarker <f> MapMarker
(options) -> <o> MapMarker object
options <o> Options object
color <a|[255, 0, 0]> marker color
map <o|null> map

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

@ -2,7 +2,7 @@
/*@
Ox.MapPlace <f> MapPlace Object
(options) -> <f> MapPlace Object
(options) -> <o> MapPlace Object
options <o> Options object
east <n|0>
editing <b|false>

5
source/Ox.UI/js/Map/MapRectangle.js
View file

@ -2,14 +2,13 @@
/*@
Ox.MapRectangle <f> MapRectangle Object
([options[, self]]) -> <f> MapRectangle Object
(options) -> <o> MapRectangle Object
options <o> Options object
map <o|null> map
place <o|null> place
self <o> shared private variable
@*/
Ox.MapRectangle = function(options, self) {
Ox.MapRectangle = function(options) {
var that = this;
options = Ox.extend({

5
source/Ox.UI/js/Map/MapRectangleMarker.js
View file

@ -2,15 +2,14 @@
/*@
Ox.MapRectangleMarker <f> MapRectangleMarker Object
([options[, self]]) -> <o> MapRectangleMarker Object
(options) -> <o> MapRectangleMarker Object
options <o> Options object
map <o|null> map
place <o|null> place
position <s|''>
self <o> shared private variable
@*/
Ox.MapRectangleMarker = function(options, self) {
Ox.MapRectangleMarker = function(options) {
options = Ox.extend({
map: null,

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.MainMenu <f:Ox.Bar> MainMenu Object
([options[, self]]) -> <o> MainMenu Object
Ox.MainMenu <f> MainMenu Object
([options[, self]]) -> <o:Ox.Bar> MainMenu Object
options <o> Options object
extras <a|[]> extra menus
menus <a|[]> submenus

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Menu <f:Ox.Element> Menu Object
([options[, self]]) -> <f> Menu Object
Ox.Menu <f> Menu Object
([options[, self]]) -> <o:Ox.Element> Menu Object
options <o> Options object
element <o> the element the menu is attached to
id <s> the menu id

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.MenuButton <f:Ox.Element> Menu Button
([options[, self]]) -> <o> Menu Button
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

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.MenuItem <f:Ox.Element> MenuItem Object
([options[, self]]) -> <o> MenuItem Object
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>

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.CollapsePanel <f:Ox.Element> CollapsePanel Object
([options[, self]]) -> <o> CollapsePanel Object
Ox.CollapsePanel <f> CollapsePanel Object
([options[, self]]) -> <o:Ox.Element> CollapsePanel Object
options <o> Options object
collapsed <b|false> collapsed state
extras <a|[]> panel extras

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.SplitPanel <f:Ox.Element> SpliPanel Object
() -> <o> SpliPanel Object
(options) -> <o> SpliPanel Object
(options, self) -> <o> SpliPanel Object
Ox.SplitPanel <f> SpliPanel Object
([options[, self]]) -> <o:Ox.Element> SpliPanel Object
options <o> Options object
elements <[o]|[]> Array of two or three element objects
collapsible <b|false> If true, can be collapsed (if outer element)

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

@ -1,9 +1,8 @@
'use strict';
/*@
Ox.TabPanel <f:Ox.Element> Tabbed panel
(options) -> <o> Panel
(options, self) -> <o> Panel
Ox.TabPanel <f> Tabbed panel
([options[, self]]) -> <o:Ox.SplitPanel> Panel
options <o> Options
content <o|f> Content per tab
Either <code>({id1: $element1, id2: $element2}}</code> or

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.AnnotationFolder <f:Ox.Element> AnnotationFolder Object
([options[, self]]) -> <o> AnnotationFolder Object
Ox.AnnotationFolder <f> AnnotationFolder Object
([options[, self]]) -> <o:Ox.CollapsePanel> AnnotationFolder Object
options <o> Options object
editable <b|false> If true, annotations can be added
id <s> id

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.AnnotationPanel <f:Ox.Element> Video Annotation Panel
([options[, self]]) -> <f> AnnotationPanel Object
Ox.AnnotationPanel <f> Video Annotation Panel
([options[, self]]) -> <o:Ox.SplitPanel> AnnotationPanel Object
options <o> Options object
calendarSize <n|256> calendar size
clickLink <f|null> click link callback

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

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

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.LargeVideoTimeline <f:Ox.Element> LargeTimeline Object
() -> <f> LargeTimeline Object
(options) -> <f> LargeTimeline Object
(options, self) -> <f> LargeTimeline Object
Ox.LargeVideoTimeline <f> LargeTimeline Object
([options[, self]]) -> <o:Ox.Element> LargeTimeline Object
options <o> Options object
self <o> shared private variable
@*/

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

@ -1,7 +1,8 @@
'use strict';
/*@
Ox.SmallVideoTimeline <f:Ox.Element> Small Video Timeline
Ox.SmallVideoTimeline <f> Small video timeline
([options[, self]]) -> <o:Ox.Element> Small video timeline
@*/
Ox.SmallVideoTimeline = function(options, self) {

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

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

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.VideoEditor <f:Ox.Element> VideoEditor Object
() -> <o> VideoEditor Object
(options) -> <o> VideoEditor Object
(options, self) -> <o> VideoEditor Object
Ox.VideoEditor <f> VideoEditor Object
([options[, self]]) -> <o:Ox.SplitPanel> VideoEditor Object
options <o> Options object
annotationsCalendarSize <n|256>
self <o> shared private variable

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

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

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

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

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.VideoPanel <f:Ox.Element> VideoPanel Object
() -> <o> VideoPanel Object
(options) -> <o> VideoPanel Object
(options, self) -> <o> VideoPanel Object
Ox.VideoPanel <f> VideoPanel Object
([options[, self]]) -> <o:Ox.SplitPanel> VideoPanel Object
options <o> Options object
self <o> shared private variable
@*/

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.VideoPlayer <f:Ox.Element> Generic Video Player
(options, self) -> <o> Video Player
Ox.VideoPlayer <f> Generic Video Player
([options[, self]]) -> <o:Ox.Element> Video Player
options <o> Options
annotations <[]> Array of annotations
id <s> Optional id

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

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

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

@ -1,7 +1,8 @@
'use strict';
/*@
Ox.VideoTimelinePanel <f:Ox.Element> VideoTimelinePanel
Ox.VideoTimelinePanel <f> Video timeline panel
([options[, self]]) -> <o:Ox.SplitPanel> Video timeline panel
@*/
Ox.VideoTimelinePanel = function(options, self) {

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

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

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

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

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

@ -1,8 +1,8 @@
'use strict';
/*@
Ox.Layer <f:Ox.Element> Background layer for dialogs and menus
(options, self) -> <o> Layer
Ox.Layer <f> Background layer for dialogs and menus
([options[, self]]) -> <o:Ox.Element> Layer
options <o> Options
type <s|'dialog'> Layer type ('dialog' or 'menu')
self <o> Shared private variable

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

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