From 509745407b3cfef6869514f0e86d50c3199ae9fd Mon Sep 17 00:00:00 2001 From: j <0x006A@0x2620.org> Date: Mon, 21 May 2012 12:38:18 +0200 Subject: [PATCH] add documentation stubs --- source/Ox.UI/js/Bar/Ox.Bar.js | 1 - source/Ox.UI/js/Bar/Ox.Resizebar.js | 1 - source/Ox.UI/js/Bar/Ox.Tabbar.js | 3 -- source/Ox.UI/js/Bar/Ox.Toolbar.js | 1 - source/Ox.UI/js/Calendar/Ox.Calendar.js | 26 +++++++++- source/Ox.UI/js/Calendar/Ox.CalendarDate.js | 1 - source/Ox.UI/js/Calendar/Ox.ListCalendar.js | 2 - source/Ox.UI/js/Code/Ox.DocPage.js | 1 + source/Ox.UI/js/Code/Ox.ExamplePage.js | 7 +++ source/Ox.UI/js/Code/Ox.ExamplePanel.js | 9 +++- source/Ox.UI/js/Code/Ox.SourceViewer.js | 9 +++- source/Ox.UI/js/Code/Ox.SyntaxHighlighter.js | 2 - source/Ox.UI/js/Core/Ox.API.js | 2 +- source/Ox.UI/js/Core/Ox.App.js | 2 - source/Ox.UI/js/Core/Ox.Clipboard.js | 2 +- source/Ox.UI/js/Core/Ox.Container.js | 2 +- source/Ox.UI/js/Core/Ox.Element.js | 18 ++++++- source/Ox.UI/js/Core/Ox.Focus.js | 6 ++- source/Ox.UI/js/Core/Ox.GarbageCollection.js | 11 +++- source/Ox.UI/js/Core/Ox.History.js | 1 - source/Ox.UI/js/Core/Ox.JQueryElement.js | 2 - source/Ox.UI/js/Core/Ox.Keyboard.js | 10 +++- source/Ox.UI/js/Core/Ox.LoadingIcon.js | 2 +- source/Ox.UI/js/Core/Ox.Progressbar.js | 3 +- source/Ox.UI/js/Core/Ox.Request.js | 2 +- source/Ox.UI/js/Core/Ox.Theme.js | 8 ++- source/Ox.UI/js/Core/Ox.URL.js | 7 ++- source/Ox.UI/js/Form/Ox.ArrayEditable.js | 16 ++++++ source/Ox.UI/js/Form/Ox.ArrayInput.js | 6 ++- source/Ox.UI/js/Form/Ox.Button.js | 6 ++- source/Ox.UI/js/Form/Ox.ButtonGroup.js | 2 +- source/Ox.UI/js/Form/Ox.Checkbox.js | 2 +- source/Ox.UI/js/Form/Ox.CheckboxGroup.js | 2 - source/Ox.UI/js/Form/Ox.ColorInput.js | 2 +- source/Ox.UI/js/Form/Ox.ColorPicker.js | 2 +- source/Ox.UI/js/Form/Ox.DateInput.js | 2 +- source/Ox.UI/js/Form/Ox.DateTimeInput.js | 2 +- source/Ox.UI/js/Form/Ox.Editable.js | 1 + source/Ox.UI/js/Form/Ox.FileButton.js | 14 +++++- source/Ox.UI/js/Form/Ox.FileInput.js | 7 +++ source/Ox.UI/js/Form/Ox.Filter.js | 5 +- source/Ox.UI/js/Form/Ox.Form.js | 19 ++++++- source/Ox.UI/js/Form/Ox.FormElementGroup.js | 9 +++- source/Ox.UI/js/Form/Ox.FormItem.js | 2 - source/Ox.UI/js/Form/Ox.FormPanel.js | 13 +++++ source/Ox.UI/js/Form/Ox.Input.js | 11 +++- source/Ox.UI/js/Form/Ox.InputGroup.js | 2 - source/Ox.UI/js/Form/Ox.InsertHTMLDialog.js | 6 +++ source/Ox.UI/js/Form/Ox.Label.js | 2 +- source/Ox.UI/js/Form/Ox.ObjectArrayInput.js | 14 +++++- source/Ox.UI/js/Form/Ox.ObjectInput.js | 8 ++- source/Ox.UI/js/Form/Ox.OptionGroup.js | 5 +- source/Ox.UI/js/Form/Ox.Picker.js | 2 +- source/Ox.UI/js/Form/Ox.PlaceInput.js | 2 - source/Ox.UI/js/Form/Ox.PlacePicker.js | 2 - source/Ox.UI/js/Form/Ox.Range.js | 2 - source/Ox.UI/js/Form/Ox.Select.js | 11 +++- source/Ox.UI/js/Form/Ox.SelectInput.js | 13 ++++- source/Ox.UI/js/Form/Ox.Spreadsheet.js | 8 ++- source/Ox.UI/js/Form/Ox.TimeInput.js | 2 - source/Ox.UI/js/List/Ox.IconItem.js | 2 - source/Ox.UI/js/List/Ox.IconList.js | 10 +++- source/Ox.UI/js/List/Ox.InfoList.js | 42 +++++++++++++++- source/Ox.UI/js/List/Ox.List.js | 6 ++- source/Ox.UI/js/List/Ox.ListItem.js | 2 - source/Ox.UI/js/List/Ox.ListPage.js | 2 +- source/Ox.UI/js/List/Ox.TextList.js | 42 +++++++++++++++- source/Ox.UI/js/List/Ox.TreeList.js | 11 +++- source/Ox.UI/js/Map/Ox.ListMap.js | 2 - source/Ox.UI/js/Map/Ox.Map.js | 50 ++++++++++++++++++- source/Ox.UI/js/Map/Ox.MapImage.js | 2 - source/Ox.UI/js/Map/Ox.MapMarker.js | 2 - source/Ox.UI/js/Map/Ox.MapMarkerImage.js | 2 - source/Ox.UI/js/Map/Ox.MapPlace.js | 2 - source/Ox.UI/js/Map/Ox.MapRectangle.js | 2 - source/Ox.UI/js/Map/Ox.MapRectangleMarker.js | 2 - source/Ox.UI/js/Menu/Ox.MainMenu.js | 10 +++- source/Ox.UI/js/Menu/Ox.Menu.js | 34 ++++++++++--- source/Ox.UI/js/Menu/Ox.MenuButton.js | 22 +++++--- source/Ox.UI/js/Menu/Ox.MenuItem.js | 2 +- source/Ox.UI/js/Panel/Ox.CollapsePanel.js | 2 - source/Ox.UI/js/Panel/Ox.Panel.js | 2 - source/Ox.UI/js/Panel/Ox.SplitPanel.js | 4 +- source/Ox.UI/js/Panel/Ox.TabPanel.js | 12 +++-- source/Ox.UI/js/Video/Ox.AnnotationFolder.js | 26 +++++++++- source/Ox.UI/js/Video/Ox.AnnotationPanel.js | 20 ++++++++ .../Ox.UI/js/Video/Ox.BlockVideoTimeline.js | 8 ++- .../Ox.UI/js/Video/Ox.LargeVideoTimeline.js | 2 - .../Ox.UI/js/Video/Ox.SmallVideoTimeline.js | 1 - .../js/Video/Ox.SmallVideoTimelineImage.js | 6 +++ source/Ox.UI/js/Video/Ox.VideoEditor.js | 6 ++- source/Ox.UI/js/Video/Ox.VideoEditorPlayer.js | 2 - source/Ox.UI/js/Video/Ox.VideoElement.js | 2 - source/Ox.UI/js/Video/Ox.VideoPanel.js | 2 - source/Ox.UI/js/Video/Ox.VideoPlayer.js | 6 ++- source/Ox.UI/js/Video/Ox.VideoPreview.js | 8 ++- .../Ox.UI/js/Video/Ox.VideoTimelinePanel.js | 8 +-- .../Ox.UI/js/Video/Ox.VideoTimelinePlayer.js | 12 ++++- source/Ox.UI/js/Window/Ox.Dialog.js | 31 +++++++++++- source/Ox.UI/js/Window/Ox.Layer.js | 12 +++-- source/Ox.UI/js/Window/Ox.Tooltip.js | 10 +++- source/Ox/js/Core.js | 2 - 102 files changed, 613 insertions(+), 163 deletions(-) diff --git a/source/Ox.UI/js/Bar/Ox.Bar.js b/source/Ox.UI/js/Bar/Ox.Bar.js index 57d04d65..3f6edbc1 100644 --- a/source/Ox.UI/js/Bar/Ox.Bar.js +++ b/source/Ox.UI/js/Bar/Ox.Bar.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; /*@ Ox.Bar Bar diff --git a/source/Ox.UI/js/Bar/Ox.Resizebar.js b/source/Ox.UI/js/Bar/Ox.Resizebar.js index 07506ced..5058f9ff 100644 --- a/source/Ox.UI/js/Bar/Ox.Resizebar.js +++ b/source/Ox.UI/js/Bar/Ox.Resizebar.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; /*@ Ox.Resizebar Resizebar diff --git a/source/Ox.UI/js/Bar/Ox.Tabbar.js b/source/Ox.UI/js/Bar/Ox.Tabbar.js index a6f38b6d..4352dce1 100644 --- a/source/Ox.UI/js/Bar/Ox.Tabbar.js +++ b/source/Ox.UI/js/Bar/Ox.Tabbar.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; /*@ Ox.Tabbar Tabbar @@ -10,8 +9,6 @@ Ox.Tabbar Tabbar tabs tabs self Shared private variable @*/ -/** -*/ Ox.Tabbar = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Bar/Ox.Toolbar.js b/source/Ox.UI/js/Bar/Ox.Toolbar.js index 9f930295..d3d5fa1a 100644 --- a/source/Ox.UI/js/Bar/Ox.Toolbar.js +++ b/source/Ox.UI/js/Bar/Ox.Toolbar.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; /** fixme: no need for this diff --git a/source/Ox.UI/js/Calendar/Ox.Calendar.js b/source/Ox.UI/js/Calendar/Ox.Calendar.js index 0d5ec623..effd4f45 100644 --- a/source/Ox.UI/js/Calendar/Ox.Calendar.js +++ b/source/Ox.UI/js/Calendar/Ox.Calendar.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -1257,6 +1255,10 @@ Ox.Calendar = function(options, self) { } }; + /*@ + that.addEvent addEvent + (event) -> object + @*/ that.addEvent = function(event) { // Ox.Log('Calendar', 'CALENDAR ADD EVENT', event) event = getEventData(event); @@ -1305,15 +1307,27 @@ Ox.Calendar = function(options, self) { return that; }; + /*@ + that.getBounds get bounds + () -> object + @*/ that.getBounds = function() { return getCalendarEvent(); }; + /*@ + that.panToEvent pan to event + () -> object + @*/ that.panToEvent = function() { panToSelected(); return that; }; + /*@ + that.removeEvent remvoe Event + () -> object + @*/ that.removeEvent = function() { Ox.Log('Calendar', 'REMOVE ... SELF.OPTIONS', self.options) var index = Ox.getIndexById(self.options.events, self.options.selected); @@ -1325,6 +1339,10 @@ Ox.Calendar = function(options, self) { return that; }; + /*@ + that.resizeCalendar resize + () -> object + @*/ that.resizeCalendar = function() { self.options.width = that.width(); self.options.height = that.height(); @@ -1333,6 +1351,10 @@ Ox.Calendar = function(options, self) { return that; }; + /*@ + that.zoomToEvent zoom to event + () -> object + @*/ that.zoomToEvent = function() { zoomToSelected(); return that; diff --git a/source/Ox.UI/js/Calendar/Ox.CalendarDate.js b/source/Ox.UI/js/Calendar/Ox.CalendarDate.js index ba72edc2..a598980e 100644 --- a/source/Ox.UI/js/Calendar/Ox.CalendarDate.js +++ b/source/Ox.UI/js/Calendar/Ox.CalendarDate.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; /*@ Ox.CalendarDate CalendarDate diff --git a/source/Ox.UI/js/Calendar/Ox.ListCalendar.js b/source/Ox.UI/js/Calendar/Ox.ListCalendar.js index 5942b266..c1cd6ad0 100644 --- a/source/Ox.UI/js/Calendar/Ox.ListCalendar.js +++ b/source/Ox.UI/js/Calendar/Ox.ListCalendar.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Code/Ox.DocPage.js b/source/Ox.UI/js/Code/Ox.DocPage.js index 69dc1cf9..67b71141 100644 --- a/source/Ox.UI/js/Code/Ox.DocPage.js +++ b/source/Ox.UI/js/Code/Ox.DocPage.js @@ -1,4 +1,5 @@ 'use strict'; + /*@ Ox.DocPage DocPage () -> DocPage object diff --git a/source/Ox.UI/js/Code/Ox.ExamplePage.js b/source/Ox.UI/js/Code/Ox.ExamplePage.js index 28b41491..a75b8448 100644 --- a/source/Ox.UI/js/Code/Ox.ExamplePage.js +++ b/source/Ox.UI/js/Code/Ox.ExamplePage.js @@ -1,5 +1,12 @@ 'use strict' +/*@ +Ox.ExamaplePage Example Page + (options[, self]) -> Example Page + options Options + self Shared private variable +@*/ + Ox.ExamplePage = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Code/Ox.ExamplePanel.js b/source/Ox.UI/js/Code/Ox.ExamplePanel.js index 961e1ea4..a2f03aeb 100644 --- a/source/Ox.UI/js/Code/Ox.ExamplePanel.js +++ b/source/Ox.UI/js/Code/Ox.ExamplePanel.js @@ -1,5 +1,12 @@ 'use strict'; +/*@ +Ox.ExamaplePanel Example Panel + (options[, self]) -> Example Panel + options Options + self Shared private variable +@*/ + Ox.ExamplePanel = function(options, self) { self = self || {}; @@ -123,4 +130,4 @@ Ox.ExamplePanel = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Code/Ox.SourceViewer.js b/source/Ox.UI/js/Code/Ox.SourceViewer.js index fc1b9797..e9f4106a 100644 --- a/source/Ox.UI/js/Code/Ox.SourceViewer.js +++ b/source/Ox.UI/js/Code/Ox.SourceViewer.js @@ -1,5 +1,12 @@ 'use strict'; +/*@ +Ox.SourceViewer Source Viewer + (options[, self]) -> Source Viewer + options Options + self Shared private variable +@*/ + Ox.SourceViewer = function(options, self) { self = self || {}; @@ -73,4 +80,4 @@ Ox.SourceViewer = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Code/Ox.SyntaxHighlighter.js b/source/Ox.UI/js/Code/Ox.SyntaxHighlighter.js index b97b4d52..216d07d9 100644 --- a/source/Ox.UI/js/Code/Ox.SyntaxHighlighter.js +++ b/source/Ox.UI/js/Code/Ox.SyntaxHighlighter.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Core/Ox.API.js b/source/Ox.UI/js/Core/Ox.API.js index 7ee69967..80f3b25d 100644 --- a/source/Ox.UI/js/Core/Ox.API.js +++ b/source/Ox.UI/js/Core/Ox.API.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.API bind remote api to object options Options object diff --git a/source/Ox.UI/js/Core/Ox.App.js b/source/Ox.UI/js/Core/Ox.App.js index db3107c7..ce2f2cea 100644 --- a/source/Ox.UI/js/Core/Ox.App.js +++ b/source/Ox.UI/js/Core/Ox.App.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Core/Ox.Clipboard.js b/source/Ox.UI/js/Core/Ox.Clipboard.js index 75949013..93cb0270 100644 --- a/source/Ox.UI/js/Core/Ox.Clipboard.js +++ b/source/Ox.UI/js/Core/Ox.Clipboard.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Clipboard Basic clipboard handler copy Copy data to clipboard diff --git a/source/Ox.UI/js/Core/Ox.Container.js b/source/Ox.UI/js/Core/Ox.Container.js index fb9ea1cf..644bda67 100644 --- a/source/Ox.UI/js/Core/Ox.Container.js +++ b/source/Ox.UI/js/Core/Ox.Container.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + // fixme: wouldn't it be better to let the elements be, // rather then $element, $content, and potentially others, // 0, 1, 2, etc, so that append would append 0, and appendTo diff --git a/source/Ox.UI/js/Core/Ox.Element.js b/source/Ox.UI/js/Core/Ox.Element.js index c0b33c28..a4f42a06 100644 --- a/source/Ox.UI/js/Core/Ox.Element.js +++ b/source/Ox.UI/js/Core/Ox.Element.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -321,6 +319,10 @@ Ox.Element = function(options, self) { return that; }; + /*@ + bindKeyboard bind keyboard + () -> object + @*/ that.bindKeyboard = function() { Ox.Keyboard.bind(that.id); return that; @@ -410,6 +412,10 @@ Ox.Element = function(options, self) { return that; }; + /*@ + setElement set $element + ($element) -> null + @*/ that.setElement = function($element) { //$element[0].className = that.$element[0].className; $element.addClass('OxElement').data({oxid: that.id}); @@ -418,6 +424,10 @@ Ox.Element = function(options, self) { that[0] = that.$element[0]; }; + /*@ + toggleOption toggle option + () -> object + @*/ that.toggleOption = function() { var options = {}; Ox.toArray(arguments[0]).forEach(function(key) { @@ -480,6 +490,10 @@ Ox.Element = function(options, self) { return that; }; + /*@ + unbindKeyboard unbind keyboard + () -> object + @*/ that.unbindKeyboard = function() { Ox.Keyboard.unbind(that.id); return that; diff --git a/source/Ox.UI/js/Core/Ox.Focus.js b/source/Ox.UI/js/Core/Ox.Focus.js index fde85e6c..dbb52b1e 100644 --- a/source/Ox.UI/js/Core/Ox.Focus.js +++ b/source/Ox.UI/js/Core/Ox.Focus.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Focus Basic focus handler @*/ @@ -64,6 +64,10 @@ Ox.Focus = (function() { focused: function() { return stack.length ? stack[stack.length - 1] : null; }, + /*@ + remove remove + (id) -> + @*/ remove: function(id) { var index = stack.indexOf(id); index > -1 && stack.splice(index, 1); diff --git a/source/Ox.UI/js/Core/Ox.GarbageCollection.js b/source/Ox.UI/js/Core/Ox.GarbageCollection.js index c96ccac8..51e62a9f 100644 --- a/source/Ox.UI/js/Core/Ox.GarbageCollection.js +++ b/source/Ox.UI/js/Core/Ox.GarbageCollection.js @@ -1,6 +1,11 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; +/*@ +Ox.GarbageCollection GarbageCollection + () -> run garbage collection + debug() -> {} output debug information +@*/ + Ox.GarbageCollection = (function() { var that = function() { @@ -26,6 +31,10 @@ Ox.GarbageCollection = (function() { Ox.Log('GC', len, '-->', Ox.len(Ox.UI.elements)); } + /*@ + debug debug info + () -> + @*/ that.debug = function() { var classNames = {}, sorted = []; Ox.forEach(Ox.UI.elements, function(element, id) { diff --git a/source/Ox.UI/js/Core/Ox.History.js b/source/Ox.UI/js/Core/Ox.History.js index 2eb8c4c9..e9bb7482 100644 --- a/source/Ox.UI/js/Core/Ox.History.js +++ b/source/Ox.UI/js/Core/Ox.History.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript /*** Ox.History ***/ diff --git a/source/Ox.UI/js/Core/Ox.JQueryElement.js b/source/Ox.UI/js/Core/Ox.JQueryElement.js index 652af550..1a737d3b 100644 --- a/source/Ox.UI/js/Core/Ox.JQueryElement.js +++ b/source/Ox.UI/js/Core/Ox.JQueryElement.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Core/Ox.Keyboard.js b/source/Ox.UI/js/Core/Ox.Keyboard.js index 5b9711d5..08eb9853 100644 --- a/source/Ox.UI/js/Core/Ox.Keyboard.js +++ b/source/Ox.UI/js/Core/Ox.Keyboard.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Keyboard Basic keyboard handler @*/ @@ -82,10 +82,18 @@ Ox.Keyboard = (function() { } return { + /*@ + bind bind + (id) -> bind id + @*/ bind: function(id) { var index = bound.indexOf(id); index == -1 && bound.push(id); }, + /*@ + unbind unbind + (id) -> unbind id + @*/ unbind: function(id) { var index = bound.indexOf(id); index > -1 && bound.splice(index, 1); diff --git a/source/Ox.UI/js/Core/Ox.LoadingIcon.js b/source/Ox.UI/js/Core/Ox.LoadingIcon.js index eee9982a..c4c2dca0 100644 --- a/source/Ox.UI/js/Core/Ox.LoadingIcon.js +++ b/source/Ox.UI/js/Core/Ox.LoadingIcon.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.LoadingIcon Loading Icon Element () -> Loading Icon Element diff --git a/source/Ox.UI/js/Core/Ox.Progressbar.js b/source/Ox.UI/js/Core/Ox.Progressbar.js index d03a38e5..488e9b37 100644 --- a/source/Ox.UI/js/Core/Ox.Progressbar.js +++ b/source/Ox.UI/js/Core/Ox.Progressbar.js @@ -1,6 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; /** Ox.Progressbar */ -// FIXME: remove this! \ No newline at end of file +// FIXME: remove this! diff --git a/source/Ox.UI/js/Core/Ox.Request.js b/source/Ox.UI/js/Core/Ox.Request.js index 712dd350..8bb3fb41 100644 --- a/source/Ox.UI/js/Core/Ox.Request.js +++ b/source/Ox.UI/js/Core/Ox.Request.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Request Basic request handler object FIXME: options is not a property, just documenting defaults diff --git a/source/Ox.UI/js/Core/Ox.Theme.js b/source/Ox.UI/js/Core/Ox.Theme.js index e8ab1135..f3855c27 100644 --- a/source/Ox.UI/js/Core/Ox.Theme.js +++ b/source/Ox.UI/js/Core/Ox.Theme.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -123,12 +121,18 @@ Ox.Theme = (function() { return that; } + /*@ + formatColor formatColor + @*/ that.formatColor = function(val, type) { return renderElement(val, type) .css({textAlign: 'center'}) .html(Ox.formatNumber(val, 3)); }; + /*@ + formatColorLevel formatColorLevel + @*/ that.formatColorLevel = function(index, values, hueRange) { hueRange = hueRange || (Ox.isBoolean(index) ? [0, 120] : [120, 0]); var step = (hueRange[1] - hueRange[0]) / (values.length - 1), diff --git a/source/Ox.UI/js/Core/Ox.URL.js b/source/Ox.UI/js/Core/Ox.URL.js index adf5cfdf..0397d05f 100644 --- a/source/Ox.UI/js/Core/Ox.URL.js +++ b/source/Ox.UI/js/Core/Ox.URL.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -633,6 +631,11 @@ Ox.URL = function(options) { } + /*@ + parse parse + (callback) -> parse state from document.location + (url, callback) -> parse state from passed url + @*/ that.parse = function() { var str = arguments.length == 2 ? arguments[0] : document.location.pathname diff --git a/source/Ox.UI/js/Form/Ox.ArrayEditable.js b/source/Ox.UI/js/Form/Ox.ArrayEditable.js index 1cbeee12..6b35afdb 100644 --- a/source/Ox.UI/js/Form/Ox.ArrayEditable.js +++ b/source/Ox.UI/js/Form/Ox.ArrayEditable.js @@ -337,6 +337,10 @@ Ox.ArrayEditable = function(options, self) { } } + /*@ + addItem addItem + (position, item) -> add item at position + @*/ that.addItem = function(position, item) { if (self.options.editable) { self.options.items.splice(position, 0, item); @@ -354,6 +358,9 @@ Ox.ArrayEditable = function(options, self) { */ }; + /*@ + blurItem blurItem + @*/ that.blurItem = function() { /* if (self.options.selected) { @@ -368,6 +375,9 @@ Ox.ArrayEditable = function(options, self) { return that; }; + /*@ + editItem editItem + @*/ that.editItem = function() { Ox.Log('AE', 'EDIT ITEM', self.options.editable, self.options.selected); if (self.options.editable && self.options.selected) { @@ -379,11 +389,17 @@ Ox.ArrayEditable = function(options, self) { return that; }; + /*@ + reloadItems reloadItems + @*/ that.reloadItems = function() { renderItems(); return that; }; + /*@ + removeItem removeItem + @*/ that.removeItem = function() { if (self.options.editable && self.options.selected) { deleteItem(); diff --git a/source/Ox.UI/js/Form/Ox.ArrayInput.js b/source/Ox.UI/js/Form/Ox.ArrayInput.js index 505275e9..08ab1fbf 100644 --- a/source/Ox.UI/js/Form/Ox.ArrayInput.js +++ b/source/Ox.UI/js/Form/Ox.ArrayInput.js @@ -175,6 +175,10 @@ Ox.ArrayInput = function(options, self) { } } + /*@ + setErrors setErrors + (values) -> set erros + @*/ that.setErrors = function(values) { self.$input.forEach(function($input) { $input[ @@ -185,4 +189,4 @@ Ox.ArrayInput = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Form/Ox.Button.js b/source/Ox.UI/js/Form/Ox.Button.js index ee46380c..9a650fbe 100644 --- a/source/Ox.UI/js/Form/Ox.Button.js +++ b/source/Ox.UI/js/Form/Ox.Button.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -142,6 +140,10 @@ Ox.Button = function(options, self) { } }; + /*@ + toggle toggle + () -> toggle button + @*/ that.toggle = function() { if (self.options.values.length) { self.value = 1 - Ox.getIndexById(self.options.values, self.options.value); diff --git a/source/Ox.UI/js/Form/Ox.ButtonGroup.js b/source/Ox.UI/js/Form/Ox.ButtonGroup.js index 65ad8568..5a0fc0b9 100644 --- a/source/Ox.UI/js/Form/Ox.ButtonGroup.js +++ b/source/Ox.UI/js/Form/Ox.ButtonGroup.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.ButtonGroup ButtonGroup Object () -> ButtonGroup Object diff --git a/source/Ox.UI/js/Form/Ox.Checkbox.js b/source/Ox.UI/js/Form/Ox.Checkbox.js index 40d9bc3c..e5cdff4b 100644 --- a/source/Ox.UI/js/Form/Ox.Checkbox.js +++ b/source/Ox.UI/js/Form/Ox.Checkbox.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Checkbox Checkbox Element () -> Checkbox Element diff --git a/source/Ox.UI/js/Form/Ox.CheckboxGroup.js b/source/Ox.UI/js/Form/Ox.CheckboxGroup.js index 0bb51af9..10ac8c6d 100644 --- a/source/Ox.UI/js/Form/Ox.CheckboxGroup.js +++ b/source/Ox.UI/js/Form/Ox.CheckboxGroup.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Form/Ox.ColorInput.js b/source/Ox.UI/js/Form/Ox.ColorInput.js index b1b36ce0..b01a0851 100644 --- a/source/Ox.UI/js/Form/Ox.ColorInput.js +++ b/source/Ox.UI/js/Form/Ox.ColorInput.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.ColorInput ColorInput Element () -> ColorInput Element diff --git a/source/Ox.UI/js/Form/Ox.ColorPicker.js b/source/Ox.UI/js/Form/Ox.ColorPicker.js index 76063bd6..98f22a38 100644 --- a/source/Ox.UI/js/Form/Ox.ColorPicker.js +++ b/source/Ox.UI/js/Form/Ox.ColorPicker.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.ColorPicker ColorPicker Element () -> ColorPicker Element diff --git a/source/Ox.UI/js/Form/Ox.DateInput.js b/source/Ox.UI/js/Form/Ox.DateInput.js index adbbfd9c..91550f26 100644 --- a/source/Ox.UI/js/Form/Ox.DateInput.js +++ b/source/Ox.UI/js/Form/Ox.DateInput.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.DateInput DateInput Element () -> DateInput Element diff --git a/source/Ox.UI/js/Form/Ox.DateTimeInput.js b/source/Ox.UI/js/Form/Ox.DateTimeInput.js index b19aeec3..0a112eb5 100644 --- a/source/Ox.UI/js/Form/Ox.DateTimeInput.js +++ b/source/Ox.UI/js/Form/Ox.DateTimeInput.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.DateTimeInput DateTimeInput Element () -> DateTimeInput Element diff --git a/source/Ox.UI/js/Form/Ox.Editable.js b/source/Ox.UI/js/Form/Ox.Editable.js index f56f46c8..a3b5aafc 100644 --- a/source/Ox.UI/js/Form/Ox.Editable.js +++ b/source/Ox.UI/js/Form/Ox.Editable.js @@ -1,4 +1,5 @@ 'use strict'; + /*@ Ox.Editable Editable element () -> Input Element diff --git a/source/Ox.UI/js/Form/Ox.FileButton.js b/source/Ox.UI/js/Form/Ox.FileButton.js index 715cc234..6a9f49d4 100644 --- a/source/Ox.UI/js/Form/Ox.FileButton.js +++ b/source/Ox.UI/js/Form/Ox.FileButton.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.FileButton File Button + (options[, self]) -> File Button + options Options + self Shared private variable +@*/ Ox.FileButton = function(options, self) { self = self || {}; @@ -101,14 +107,20 @@ Ox.FileButton = function(options, self) { } } + /*@ + blurButton blurButton + @*/ that.blurButton = function() { self.$input.blur(); } + /*@ + focusButton focusButton + @*/ that.focusButton = function() { self.$input.focus(); }; return that; -} \ No newline at end of file +} diff --git a/source/Ox.UI/js/Form/Ox.FileInput.js b/source/Ox.UI/js/Form/Ox.FileInput.js index 5396d3ef..65786f88 100644 --- a/source/Ox.UI/js/Form/Ox.FileInput.js +++ b/source/Ox.UI/js/Form/Ox.FileInput.js @@ -1,5 +1,12 @@ 'use strict'; +/*@ +Ox.FileInput File Input + (options[, self]) -> File Input + options Options + self Shared private variable +@*/ + Ox.FileInput = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Form/Ox.Filter.js b/source/Ox.UI/js/Form/Ox.Filter.js index 8059ce35..fcf14f37 100644 --- a/source/Ox.UI/js/Form/Ox.Filter.js +++ b/source/Ox.UI/js/Form/Ox.Filter.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -818,6 +816,9 @@ Ox.Filter = function(options, self) { that.triggerEvent('change', {query: query}); } + /*@ + getList getList + @*/ // fixme: is this the best way/name? that.getList = function() { if (self.$save) { diff --git a/source/Ox.UI/js/Form/Ox.Form.js b/source/Ox.UI/js/Form/Ox.Form.js index 0a20f9e3..ae4c4f45 100644 --- a/source/Ox.UI/js/Form/Ox.Form.js +++ b/source/Ox.UI/js/Form/Ox.Form.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -129,6 +127,10 @@ Ox.Form = function(options, self) { } } + /*@ + addItem addItem + (pos, item) -> add item at position + @*/ that.addItem = function(pos, item) { Ox.Log('Form', 'addItem', pos) self.options.items.splice(pos, 0, item); @@ -138,6 +140,10 @@ Ox.Form = function(options, self) { self.$items[pos].insertAfter(self.$items[pos - 1]); } + /*@ + removeItem removeItem + (pos) -> remove item from position + @*/ that.removeItem = function(pos) { Ox.Log('Form', 'removeItem', pos); self.$items[pos].remove(); @@ -145,16 +151,25 @@ Ox.Form = function(options, self) { self.$items.splice(pos, 1); } + /*@ + submit submit + @*/ that.submit = function() { // fixme: this seems to be unneeded //Ox.Log('Form', '---- that.values()', that.values()) self.options.submit(that.values(), submitCallback); }; + /*@ + valid valid + @*/ that.valid = function() { return self.formIsValid; }; + /*@ + values values + @*/ that.values = function() { // FIXME: this should accept a single string argument to get a single value /* diff --git a/source/Ox.UI/js/Form/Ox.FormElementGroup.js b/source/Ox.UI/js/Form/Ox.FormElementGroup.js index 6ae827fe..1e41e61a 100644 --- a/source/Ox.UI/js/Form/Ox.FormElementGroup.js +++ b/source/Ox.UI/js/Form/Ox.FormElementGroup.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -107,12 +105,19 @@ Ox.FormElementGroup = function(options, self) { } }; + /*@ + replaceElement replaceElement + (pos, element) -> replcae element at position + @*/ that.replaceElement = function(pos, element) { Ox.Log('Form', 'Ox.FormElementGroup replaceElement', pos, element) self.options.elements[pos].replaceWith(element.$element); self.options.elements[pos] = element; }; + /*@ + value value + @*/ that.value = function() { var values = self.options.elements.map(function(element) { return element.value(); diff --git a/source/Ox.UI/js/Form/Ox.FormItem.js b/source/Ox.UI/js/Form/Ox.FormItem.js index 7df18920..9baa6974 100644 --- a/source/Ox.UI/js/Form/Ox.FormItem.js +++ b/source/Ox.UI/js/Form/Ox.FormItem.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Form/Ox.FormPanel.js b/source/Ox.UI/js/Form/Ox.FormPanel.js index bf0181e1..464f4567 100644 --- a/source/Ox.UI/js/Form/Ox.FormPanel.js +++ b/source/Ox.UI/js/Form/Ox.FormPanel.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.FormPanel Form Panel + (options[, self]) -> Form Panel + options Options + self Shared private variable +@*/ Ox.FormPanel = function(options, self) { self = self || {}; @@ -147,6 +153,10 @@ Ox.FormPanel = function(options, self) { return index; } + /*@ + renderPrintVersion renderPrintVersion + (title) -> + @*/ that.renderPrintVersion = function(title) { var $printVersion = $('
').css({overflowY: 'auto'}); $printVersion.append( @@ -185,6 +195,9 @@ Ox.FormPanel = function(options, self) { return $printVersion; }; + /*@ + values values + @*/ that.values = function() { var values = {}; self.options.form.forEach(function(section, i) { diff --git a/source/Ox.UI/js/Form/Ox.Input.js b/source/Ox.UI/js/Form/Ox.Input.js index 49d63179..7b787f43 100644 --- a/source/Ox.UI/js/Form/Ox.Input.js +++ b/source/Ox.UI/js/Form/Ox.Input.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Input Input Element () -> Input Element @@ -886,11 +886,17 @@ Ox.Input = function(options, self) { } }; + /*@ + blurInput blurInput + @*/ that.blurInput = function() { self.$input.blur(); return that; }; + /*@ + clearInput clearInput + @*/ that.clearInput = function() { clear(); return that; @@ -918,6 +924,9 @@ Ox.Input = function(options, self) { return that; }; + /*@ + value get/set value + @*/ // FIXME: deprecate, options are enough that.value = function() { if (arguments.length == 0) { diff --git a/source/Ox.UI/js/Form/Ox.InputGroup.js b/source/Ox.UI/js/Form/Ox.InputGroup.js index 459341cc..6488b2ee 100644 --- a/source/Ox.UI/js/Form/Ox.InputGroup.js +++ b/source/Ox.UI/js/Form/Ox.InputGroup.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Form/Ox.InsertHTMLDialog.js b/source/Ox.UI/js/Form/Ox.InsertHTMLDialog.js index bd25cfdf..d0071517 100644 --- a/source/Ox.UI/js/Form/Ox.InsertHTMLDialog.js +++ b/source/Ox.UI/js/Form/Ox.InsertHTMLDialog.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.InsertHTMLDialog Insert HTML Dialog + (options[, self]) -> Insert HTML Dialog + options Options + self Shared private variable +@*/ Ox.InsertHTMLDialog = function(options, self) { var that; diff --git a/source/Ox.UI/js/Form/Ox.Label.js b/source/Ox.UI/js/Form/Ox.Label.js index 8b35313c..886858f9 100644 --- a/source/Ox.UI/js/Form/Ox.Label.js +++ b/source/Ox.UI/js/Form/Ox.Label.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Label Label Object () -> Label Object diff --git a/source/Ox.UI/js/Form/Ox.ObjectArrayInput.js b/source/Ox.UI/js/Form/Ox.ObjectArrayInput.js index 4b5203eb..5e802e07 100644 --- a/source/Ox.UI/js/Form/Ox.ObjectArrayInput.js +++ b/source/Ox.UI/js/Form/Ox.ObjectArrayInput.js @@ -1,5 +1,17 @@ 'use strict'; +/*@ +Ox.ObjectArrayInput Object Array Input + (options[, self]) -> Object Array Input + options Options + buttonTitles + inputs + labelWidth + max + value + width + self Shared private variable +@*/ Ox.ObjectArrayInput = function(options, self) { self = self || {}; @@ -159,4 +171,4 @@ Ox.ObjectArrayInput = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Form/Ox.ObjectInput.js b/source/Ox.UI/js/Form/Ox.ObjectInput.js index 47f009da..fbaaf655 100644 --- a/source/Ox.UI/js/Form/Ox.ObjectInput.js +++ b/source/Ox.UI/js/Form/Ox.ObjectInput.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.ObjectInput Object Input + (options[, self]) -> Object Input + options Options + self Shared private variable +@*/ Ox.ObjectInput = function(options, self) { self = self || {}; @@ -61,4 +67,4 @@ Ox.ObjectInput = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Form/Ox.OptionGroup.js b/source/Ox.UI/js/Form/Ox.OptionGroup.js index 8af9fe2c..f26e4bae 100644 --- a/source/Ox.UI/js/Form/Ox.OptionGroup.js +++ b/source/Ox.UI/js/Form/Ox.OptionGroup.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -107,6 +105,9 @@ Ox.OptionGroup = function(items, min, max, property) { return toggled; } + /*@ + value get value + @*/ this.value = function() { var value = Ox.map(items, function(item) { return item[property] ? item.id : null; diff --git a/source/Ox.UI/js/Form/Ox.Picker.js b/source/Ox.UI/js/Form/Ox.Picker.js index 7253534f..520fecad 100644 --- a/source/Ox.UI/js/Form/Ox.Picker.js +++ b/source/Ox.UI/js/Form/Ox.Picker.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Picker Picker Object () -> Picker Object diff --git a/source/Ox.UI/js/Form/Ox.PlaceInput.js b/source/Ox.UI/js/Form/Ox.PlaceInput.js index 2d81d9d6..58391c11 100644 --- a/source/Ox.UI/js/Form/Ox.PlaceInput.js +++ b/source/Ox.UI/js/Form/Ox.PlaceInput.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Form/Ox.PlacePicker.js b/source/Ox.UI/js/Form/Ox.PlacePicker.js index cefd9b33..2bf77e6f 100644 --- a/source/Ox.UI/js/Form/Ox.PlacePicker.js +++ b/source/Ox.UI/js/Form/Ox.PlacePicker.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Form/Ox.Range.js b/source/Ox.UI/js/Form/Ox.Range.js index eb602a11..4cdf57ee 100644 --- a/source/Ox.UI/js/Form/Ox.Range.js +++ b/source/Ox.UI/js/Form/Ox.Range.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Form/Ox.Select.js b/source/Ox.UI/js/Form/Ox.Select.js index 8aa33e93..9d1666db 100644 --- a/source/Ox.UI/js/Form/Ox.Select.js +++ b/source/Ox.UI/js/Form/Ox.Select.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -222,14 +220,23 @@ Ox.Select = function(options, self) { } }; + /*@ + disableItem disableItem + @*/ that.disableItem = function(id) { self.$menu.getItem(id).options({disabled: true}); }; + /*@ + enableItem enableItem + @*/ that.enableItem = function(id) { self.$menu.getItem(id).options({disabled: false}); }; + /*@ + remove remove + @*/ self.superRemove = that.remove; that.remove = function() { self.$menu.remove(); diff --git a/source/Ox.UI/js/Form/Ox.SelectInput.js b/source/Ox.UI/js/Form/Ox.SelectInput.js index 2efb4fef..4ce59714 100644 --- a/source/Ox.UI/js/Form/Ox.SelectInput.js +++ b/source/Ox.UI/js/Form/Ox.SelectInput.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.SelectInput Select Input + (options[, self]) -> Select Input + options Options + self Shared private variable +@*/ Ox.SelectInput = function(options, self) { var that; @@ -114,6 +120,11 @@ Ox.SelectInput = function(options, self) { } }; + /*@ + value get/set value + () -> value get value + (value) -> set value + @*/ that.value = function() { if (arguments.length == 0) { return getValue(); @@ -126,4 +137,4 @@ Ox.SelectInput = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Form/Ox.Spreadsheet.js b/source/Ox.UI/js/Form/Ox.Spreadsheet.js index 55dfeffd..7169beb8 100644 --- a/source/Ox.UI/js/Form/Ox.Spreadsheet.js +++ b/source/Ox.UI/js/Form/Ox.Spreadsheet.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.Spreadsheet Spreadsheet + (options[, self]) -> Spreadsheet + options Options + self Shared private variable +@*/ Ox.Spreadsheet = function(options, self) { self = self || {}; @@ -237,4 +243,4 @@ Ox.Spreadsheet = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Form/Ox.TimeInput.js b/source/Ox.UI/js/Form/Ox.TimeInput.js index 516d44ce..e3e10e7b 100644 --- a/source/Ox.UI/js/Form/Ox.TimeInput.js +++ b/source/Ox.UI/js/Form/Ox.TimeInput.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/List/Ox.IconItem.js b/source/Ox.UI/js/List/Ox.IconItem.js index 3787e618..a52185ca 100644 --- a/source/Ox.UI/js/List/Ox.IconItem.js +++ b/source/Ox.UI/js/List/Ox.IconItem.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=js - 'use strict'; /*@ diff --git a/source/Ox.UI/js/List/Ox.IconList.js b/source/Ox.UI/js/List/Ox.IconList.js index 741ea28b..aec37598 100644 --- a/source/Ox.UI/js/List/Ox.IconList.js +++ b/source/Ox.UI/js/List/Ox.IconList.js @@ -1,4 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=js 'use strict'; /*@ Ox.IconList IconList Object @@ -155,15 +154,24 @@ Ox.IconList = function(options, self) { return that; }; + /*@ + gainFocus gainFocus + @*/ that.gainFocus = function() { that.$element.gainFocus(); return that; }; + /*@ + hasFocus hasFocus + @*/ that.hasFocus = function() { return that.$element.hasFocus(); }; + /*@ + loseFocus loseFocus + @*/ that.loseFocus = function() { that.$element.loseFocus(); return that; diff --git a/source/Ox.UI/js/List/Ox.InfoList.js b/source/Ox.UI/js/List/Ox.InfoList.js index f77862a3..850b327a 100644 --- a/source/Ox.UI/js/List/Ox.InfoList.js +++ b/source/Ox.UI/js/List/Ox.InfoList.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.InfoList Info List + (options[, self]) -> Info List + options Options + self Shared private variable +@*/ Ox.InfoList = function(options, self) { self = self || {}; @@ -171,44 +177,72 @@ Ox.InfoList = function(options, self) { } }; + /*@ + closePreivew closePreview + @*/ that.closePreview = function() { that.$element.closePreview(); return that; }; + /*@ + gainFocus gainFocus + @*/ that.gainFocus = function() { that.$element.gainFocus(); return that; }; + /*@ + hasFocus hasFocus + @*/ that.hasFocus = function() { return that.$element.hasFocus(); }; + /*@ + loseFocus loseFocus + @*/ that.loseFocus = function() { that.$element.loseFocus(); return that; }; + /*@ + paste paste + @*/ that.paste = function(data) { that.$element.paste(data); return that; }; + /*@ + reloadList reloadList + @*/ that.reloadList = function(stayAtPosition) { that.$element.reloadList(stayAtPosition); return that; }; + /*@ + scrollToSelection scrollToSelection + @*/ that.scrollToSelection = function() { that.$element.scrollToSelection(); return that; }; + /*@ + size size + @*/ that.size = function() { that.$element.size(); }; + /*@ + sortList sortList + (key, operator) -> + @*/ that.sortList = function(key, operator) { self.options.sort = [{ key: key, @@ -219,6 +253,12 @@ Ox.InfoList = function(options, self) { return that; }; + /*@ + value value + (id) -> values + (id, key) -> value + (id, key, value) -> + @*/ that.value = function(id, key, value) { // fixme: make this accept id, {k: v, ...} if (arguments.length == 1) { @@ -233,4 +273,4 @@ Ox.InfoList = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/List/Ox.List.js b/source/Ox.UI/js/List/Ox.List.js index ddb40608..ea1476fe 100644 --- a/source/Ox.UI/js/List/Ox.List.js +++ b/source/Ox.UI/js/List/Ox.List.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -1633,6 +1631,10 @@ Ox.List = function(options, self) { return that; } + + /*@ + sort sort + @*/ // needed when a value has changed // but, fixme: better function name that.sort = function() { diff --git a/source/Ox.UI/js/List/Ox.ListItem.js b/source/Ox.UI/js/List/Ox.ListItem.js index 59e0b640..a73f10ab 100644 --- a/source/Ox.UI/js/List/Ox.ListItem.js +++ b/source/Ox.UI/js/List/Ox.ListItem.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/List/Ox.ListPage.js b/source/Ox.UI/js/List/Ox.ListPage.js index deaf7a7c..bf9045e1 100644 --- a/source/Ox.UI/js/List/Ox.ListPage.js +++ b/source/Ox.UI/js/List/Ox.ListPage.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.ListPage ListPage Object () -> ListPage Object diff --git a/source/Ox.UI/js/List/Ox.TextList.js b/source/Ox.UI/js/List/Ox.TextList.js index 2157660a..a00301a3 100644 --- a/source/Ox.UI/js/List/Ox.TextList.js +++ b/source/Ox.UI/js/List/Ox.TextList.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -838,11 +836,18 @@ Ox.TextList = function(options, self) { */ } + /*@ + closePreivew closePreview + @*/ that.closePreview = function() { that.$body.closePreview(); return that; }; + /*@ + editCell editCell + (id, key, select) -> edit cell + @*/ that.editCell = function(id, key, select) { Ox.Log('List', 'editCell', id, key) var $item = getItem(id), @@ -894,40 +899,67 @@ Ox.TextList = function(options, self) { } } + /*@ + gainFocus gainFocus + @*/ that.gainFocus = function() { that.$body.gainFocus(); return that; }; + /*@ + hasFocus hasFocus + @*/ that.hasFocus = function() { return that.$body.hasFocus(); }; + /*@ + loseFocus loseFocus + @*/ that.loseFocus = function() { that.$body.loseFocus(); return that; }; + /*@ + openPreview openPreview + @*/ that.openPreview = function() { that.$body.openPreview(); return that; }; + /*@ + paste paste + (data) -> paste data + @*/ that.paste = function(data) { that.$body.paste(); return that; }; + /*@ + reloadList reloadList + (stayAtPosition) -> reload list + @*/ that.reloadList = function(stayAtPosition) { that.$body.reloadList(stayAtPosition); return that; }; + /*@ + resizeColumn resizeColumn + (id, width) -> resize column id to width + @*/ that.resizeColumn = function(id, width) { resizeColumn(id, width); return that; } + /*@ + size size + @*/ that.size = function() { setWidth(); that.$body.size(); @@ -966,6 +998,12 @@ Ox.TextList = function(options, self) { return that; }; + /*@ + value value + (id) -> get values of row id + (id, key) -> get value of cell id, key + (id, key, value) -> set id, key to value + @*/ that.value = function(id, key, value) { // fixme: make this accept id, {k: v, ...} //Ox.Log('List', 'value', id, key, value) diff --git a/source/Ox.UI/js/List/Ox.TreeList.js b/source/Ox.UI/js/List/Ox.TreeList.js index 5ce11861..e21eeff3 100644 --- a/source/Ox.UI/js/List/Ox.TreeList.js +++ b/source/Ox.UI/js/List/Ox.TreeList.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -259,15 +257,24 @@ Ox.TreeList = function(options, self) { } }; + /*@ + gainFocus gainFocus + @*/ that.gainFocus = function() { self.$list.gainFocus(); return that; }; + /*@ + hasFocus hasFocus + @*/ that.hasFocus = function() { return self.$list.hasFocus(); }; + /*@ + loseFocus loseFocus + @*/ that.loseFocus = function() { self.$list.loseFocus(); return that; diff --git a/source/Ox.UI/js/Map/Ox.ListMap.js b/source/Ox.UI/js/Map/Ox.ListMap.js index 2687d3ae..0626fcc4 100644 --- a/source/Ox.UI/js/Map/Ox.ListMap.js +++ b/source/Ox.UI/js/Map/Ox.ListMap.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Map/Ox.Map.js b/source/Ox.UI/js/Map/Ox.Map.js index 188c5580..4ffe3033 100644 --- a/source/Ox.UI/js/Map/Ox.Map.js +++ b/source/Ox.UI/js/Map/Ox.Map.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -1442,25 +1440,45 @@ Ox.Map = function(options, self) { } }; + /*@ + addPlace addPlace + (data) -> add place to places + @*/ that.addPlace = function(data) { addPlaceToPlaces(data); }; + /*@ + getKey getKey + () -> get key + @*/ that.getKey = function() { return self.shiftKey ? 'shift' : self.metaKey ? 'meta' : null; }; + /*@ + getSelectedPlace getSelectedPlace + () -> get selected place + @*/ that.getSelectedPlace = function() { return getSelectedPlace(); } + /*@ + editPlace editPlace + () -> edit selected place + @*/ that.editPlace = function() { getSelectedPlace().edit(); return that; }; + /*@ + findPlace findPlace + (name, callback) -> find place and pass to callback + @*/ that.findPlace = function(name, callback) { getPlaceByName(name, function(place) { if (place) { @@ -1474,22 +1492,38 @@ Ox.Map = function(options, self) { return that; }; + /*@ + newPlace newPlace + (place) -> add place to map + @*/ that.newPlace = function(place) { addPlaceToMap(place); return that; }; + /*@ + panToPlace panToPlace + () -> pan to place + @*/ that.panToPlace = function() { panToPlace(); return that; }; + /*@ + removePlace removePlace + () -> remove selected place from places + @*/ that.removePlace = function() { // fixme: removePlaceFromPlaces() ? removePlace(); return that; }; + /*@ + resizeMap resizeMap + () -> resize map + @*/ that.resizeMap = function() { // keep center on resize has been commented out // var center = self.map.getCenter(); @@ -1517,6 +1551,10 @@ Ox.Map = function(options, self) { return that; } + /*@ + value value + (id, key, value) -> set id, key to value + @*/ that.value = function(id, key, value) { // fixme: should be like the corresponding List/TextList/etc value function Ox.Log('Map', 'Map.value', id, key, value); @@ -1535,11 +1573,19 @@ Ox.Map = function(options, self) { return that; } + /*@ + zoomToPlace zoomToPlace + () -> zoom to selected place + @*/ that.zoomToPlace = function() { zoomToPlace(); return that; }; + /*@ + zoom zoom + (value) -> zoom to value + @*/ that.zoom = function(value) { zoom(value); return that; diff --git a/source/Ox.UI/js/Map/Ox.MapImage.js b/source/Ox.UI/js/Map/Ox.MapImage.js index bddd6cf5..c8781a78 100644 --- a/source/Ox.UI/js/Map/Ox.MapImage.js +++ b/source/Ox.UI/js/Map/Ox.MapImage.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Map/Ox.MapMarker.js b/source/Ox.UI/js/Map/Ox.MapMarker.js index 6fb69a6e..fdb709ae 100644 --- a/source/Ox.UI/js/Map/Ox.MapMarker.js +++ b/source/Ox.UI/js/Map/Ox.MapMarker.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Map/Ox.MapMarkerImage.js b/source/Ox.UI/js/Map/Ox.MapMarkerImage.js index 41a04a1e..488c60ec 100644 --- a/source/Ox.UI/js/Map/Ox.MapMarkerImage.js +++ b/source/Ox.UI/js/Map/Ox.MapMarkerImage.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Map/Ox.MapPlace.js b/source/Ox.UI/js/Map/Ox.MapPlace.js index a503a1c6..65d75ccb 100644 --- a/source/Ox.UI/js/Map/Ox.MapPlace.js +++ b/source/Ox.UI/js/Map/Ox.MapPlace.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Map/Ox.MapRectangle.js b/source/Ox.UI/js/Map/Ox.MapRectangle.js index 40942df8..6034c3ba 100644 --- a/source/Ox.UI/js/Map/Ox.MapRectangle.js +++ b/source/Ox.UI/js/Map/Ox.MapRectangle.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Map/Ox.MapRectangleMarker.js b/source/Ox.UI/js/Map/Ox.MapRectangleMarker.js index 8d37218f..b4646428 100644 --- a/source/Ox.UI/js/Map/Ox.MapRectangleMarker.js +++ b/source/Ox.UI/js/Map/Ox.MapRectangleMarker.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Menu/Ox.MainMenu.js b/source/Ox.UI/js/Menu/Ox.MainMenu.js index 6fce7bb7..35ce8464 100644 --- a/source/Ox.UI/js/Menu/Ox.MainMenu.js +++ b/source/Ox.UI/js/Menu/Ox.MainMenu.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -211,6 +209,10 @@ Ox.MainMenu = function(options, self) { }; + /*@ + replaceMenu replace menu + (id, menu) -> replace menu + @*/ that.replaceMenu = function(id, menu) { var position = Ox.getIndexById(self.options.menus, id); self.options.menus[position] = menu; @@ -238,6 +240,10 @@ Ox.MainMenu = function(options, self) { return that; }; + /*@ + setItemTitle setItemTitle + (id, title) -> set item title + @*/ that.setItemTitle = function(id, title) { var item = that.getItem(id); item && item.options({title: title}); diff --git a/source/Ox.UI/js/Menu/Ox.Menu.js b/source/Ox.UI/js/Menu/Ox.Menu.js index 8961a6ec..b2fad415 100644 --- a/source/Ox.UI/js/Menu/Ox.Menu.js +++ b/source/Ox.UI/js/Menu/Ox.Menu.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Menu Menu Object () -> Menu Object @@ -591,14 +591,15 @@ Ox.Menu = function(options, self) { }; /*@ - addItemBefore + addItemBefore addItemBefore @*/ that.addItemBefore = function(item, id) { }; /*@ - checkItem + checkItem checkItem + (id, checked) -> check item, checked can be undefined/true or false @*/ that.checkItem = function(id, checked) { Ox.Log('Menu', 'checkItem id', id) @@ -629,12 +630,17 @@ Ox.Menu = function(options, self) { } }; + /*@ + clickItem clickItem + (position, files) -> click item at position + @*/ that.clickItem = function(position, files) { clickItem(position, files); }; /*@ - getItem + getItem getItem + (id) -> get item @*/ that.getItem = function(id) { //Ox.Log('Menu', 'getItem id', id) @@ -660,7 +666,8 @@ Ox.Menu = function(options, self) { }; /*@ - getSubmenu + getSubmenu getSubmenu + (id) -> get submenu by id @*/ that.getSubmenu = function(id) { var ids = id.split('_'), @@ -675,7 +682,8 @@ Ox.Menu = function(options, self) { } /*@ - hasEnabledItems + hasEnabledItems hasEditableItems + () -> menu has editable items @*/ that.hasEnabledItems = function() { var ret = false; @@ -688,7 +696,7 @@ Ox.Menu = function(options, self) { }; /*@ - hideMenu + hideMenu hideMenu () -> Menu Object @*/ that.hideMenu = function(hideParent) { @@ -717,6 +725,10 @@ Ox.Menu = function(options, self) { return that; }; + /*@ + remove remove + () -> remove menu + @*/ self.superRemove = that.remove; that.remove = function() { Ox.forEach(that.submenus, function(submenu) { @@ -740,6 +752,10 @@ Ox.Menu = function(options, self) { return that; }; + /*@ + setItemTitle setItemTitle + (id, title) -> set item title + @*/ that.setItemTitle = function(id, title) { var item = getItem(id); item && item.options({title: title}); @@ -803,6 +819,10 @@ Ox.Menu = function(options, self) { return that.is(':hidden') ? that.showMenu() : that.hideMenu(); }; + /*@ + uncheckItem uncheckItem + (id) -> uncheck item + @*/ that.uncheckItem = function(id) { that.checkItem(id, false); }; diff --git a/source/Ox.UI/js/Menu/Ox.MenuButton.js b/source/Ox.UI/js/Menu/Ox.MenuButton.js index 270b91dd..8eac9a04 100644 --- a/source/Ox.UI/js/Menu/Ox.MenuButton.js +++ b/source/Ox.UI/js/Menu/Ox.MenuButton.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -116,28 +114,32 @@ Ox.MenuButton = function(options, self) { } /*@ - checkItem + checkItem checkItem + (id) -> check item with id @*/ that.checkItem = function(id) { self.$menu.checkItem(id); }; /*@ - disableItem + disableItem disableItem + (id) -> disable item with id @*/ that.disableItem = function(id) { self.$menu.getItem(id).options({disabled: true}); }; /*@ - enableItem + enableItem enableItem + (id) -> enable item @*/ that.enableItem = function(id) { self.$menu.getItem(id).options({disabled: false}); }; /*@ - remove + remove remove + () -> remove item @*/ self.superRemove = that.remove; that.remove = function() { @@ -145,11 +147,19 @@ Ox.MenuButton = function(options, self) { self.superRemove(); }; + /*@ + setItemTitle setItemTitle + (id, title) -> set item title + @*/ that.setItemTitle = function(id, title) { self.$menu.setItemTitle(id, title); return that; }; + /*@ + uncheckItem uncheck item + (id) -> uncheck item with id + @*/ that.uncheckItem = function(id) { self.$menu.uncheckItem(id); }; diff --git a/source/Ox.UI/js/Menu/Ox.MenuItem.js b/source/Ox.UI/js/Menu/Ox.MenuItem.js index 7c52e003..ba0eaf83 100644 --- a/source/Ox.UI/js/Menu/Ox.MenuItem.js +++ b/source/Ox.UI/js/Menu/Ox.MenuItem.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.MenuItem MenuItem Object () -> MenuItem Object diff --git a/source/Ox.UI/js/Panel/Ox.CollapsePanel.js b/source/Ox.UI/js/Panel/Ox.CollapsePanel.js index c2018bf1..815d0648 100644 --- a/source/Ox.UI/js/Panel/Ox.CollapsePanel.js +++ b/source/Ox.UI/js/Panel/Ox.CollapsePanel.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Panel/Ox.Panel.js b/source/Ox.UI/js/Panel/Ox.Panel.js index fd2511bd..d580713b 100644 --- a/source/Ox.UI/js/Panel/Ox.Panel.js +++ b/source/Ox.UI/js/Panel/Ox.Panel.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Panel/Ox.SplitPanel.js b/source/Ox.UI/js/Panel/Ox.SplitPanel.js index 75924673..42201491 100644 --- a/source/Ox.UI/js/Panel/Ox.SplitPanel.js +++ b/source/Ox.UI/js/Panel/Ox.SplitPanel.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.SplitPanel SpliPanel Object () -> SpliPanel Object @@ -341,4 +341,4 @@ Ox.SplitPanel = function(options, self) { return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Panel/Ox.TabPanel.js b/source/Ox.UI/js/Panel/Ox.TabPanel.js index 97029dbc..6f8d6837 100644 --- a/source/Ox.UI/js/Panel/Ox.TabPanel.js +++ b/source/Ox.UI/js/Panel/Ox.TabPanel.js @@ -1,4 +1,4 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript +'use strict'; /*@ Ox.TabPanel Tabbed panel @@ -15,8 +15,6 @@ Ox.TabPanel Tabbed panel self Shared private variable @*/ -'use strict'; - Ox.TabPanel = function(options, self) { self = self || {}; @@ -77,6 +75,10 @@ Ox.TabPanel = function(options, self) { return (selected.length ? selected : self.options.tabs)[0].id; } + /*@ + select select + (id) -> select panel + @*/ // fixme: does this collide with a jquery fn? that.select = function(id) { if (Ox.getIndexById(self.options.tabs, id) > -1) { @@ -85,6 +87,10 @@ Ox.TabPanel = function(options, self) { return that; }; + /*@ + selected selected + () -> return selected panel + @*/ that.selected = function() { return self.selected; }; diff --git a/source/Ox.UI/js/Video/Ox.AnnotationFolder.js b/source/Ox.UI/js/Video/Ox.AnnotationFolder.js index 3963282b..f744e279 100644 --- a/source/Ox.UI/js/Video/Ox.AnnotationFolder.js +++ b/source/Ox.UI/js/Video/Ox.AnnotationFolder.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -583,12 +581,20 @@ Ox.AnnotationFolder = function(options, self) { return that; }; + /*@ + blurItem blur item + () -> blur selected item + @*/ that.blurItem = function() { self.editing = false; self.$annotations.blurItem(); return that; }; + /*@ + editItem edit item + () -> edit selected item + @*/ that.editItem = function() { self.editing = true; self.$panel.options({collapsed: false}); @@ -596,15 +602,27 @@ Ox.AnnotationFolder = function(options, self) { return that; }; + /*@ + gainFocus gain focus + () -> gain focus + @*/ that.gainFocus = function() { self.$annotations.gainFocus(); return that; }; + /*@ + removeItem remove item + () -> remove selected item + @*/ that.removeItem = function() { self.$annotations.removeItem(); }; + /*@ + selectItem select item + (position) -> select item at position + @*/ that.selectItem = function(position) { // selects the first (0) or last (-1) visible annotation if (self.annotations.length) { @@ -619,6 +637,10 @@ Ox.AnnotationFolder = function(options, self) { } }; + /*@ + updateItem update item + (id, data) -> update item + @*/ that.updateItem = function(id, data) { var item = Ox.getObjectById(self.options.items, id); Ox.forEach(data, function(value, key) { diff --git a/source/Ox.UI/js/Video/Ox.AnnotationPanel.js b/source/Ox.UI/js/Video/Ox.AnnotationPanel.js index a31dc336..3f208e9e 100644 --- a/source/Ox.UI/js/Video/Ox.AnnotationPanel.js +++ b/source/Ox.UI/js/Video/Ox.AnnotationPanel.js @@ -463,6 +463,10 @@ Ox.AnnotationPanel = function(options, self) { } }; + /*@ + addItem add item + (layer, item) -> add item to layer + @*/ that.addItem = function(layer, item) { // called from addannotation callback var i = Ox.getIndexById(self.options.layers, layer); @@ -476,18 +480,30 @@ Ox.AnnotationPanel = function(options, self) { renderEditMenu(); }; + /*@ + blurItem blur item + () -> blur selected item + @*/ that.blurItem = function() { self.editing = false; getFolder(self.options.selected).blurItem(); renderEditMenu(); }; + /*@ + editItem editItem + () -> put selected item into edit mode + @*/ that.editItem = function() { self.editing = true; getFolder(self.options.selected).editItem(); renderEditMenu(); }; + /*@ + removeItem removeItem + (remove) -> remove item + @*/ that.removeItem = function(remove) { if (remove) { // remove initiated by video editor @@ -501,6 +517,10 @@ Ox.AnnotationPanel = function(options, self) { } }; + /*@ + updateItem updateItem + (id, item) -> update item + @*/ that.updateItem = function(id, item) { // called from editannotation callback // on the first update of a new annotation, the id will change diff --git a/source/Ox.UI/js/Video/Ox.BlockVideoTimeline.js b/source/Ox.UI/js/Video/Ox.BlockVideoTimeline.js index 3437aa42..b7bd7d1b 100644 --- a/source/Ox.UI/js/Video/Ox.BlockVideoTimeline.js +++ b/source/Ox.UI/js/Video/Ox.BlockVideoTimeline.js @@ -1,7 +1,11 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; +/*@ +Ox.BlockVideoTimeline Block Video Timeline + (options[, self]) -> Block Video Timeline + options Options + self Shared private variable +@*/ Ox.BlockVideoTimeline = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Video/Ox.LargeVideoTimeline.js b/source/Ox.UI/js/Video/Ox.LargeVideoTimeline.js index fe7f5ed7..83f5e675 100644 --- a/source/Ox.UI/js/Video/Ox.LargeVideoTimeline.js +++ b/source/Ox.UI/js/Video/Ox.LargeVideoTimeline.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Video/Ox.SmallVideoTimeline.js b/source/Ox.UI/js/Video/Ox.SmallVideoTimeline.js index d3ebaec5..f6e1a196 100644 --- a/source/Ox.UI/js/Video/Ox.SmallVideoTimeline.js +++ b/source/Ox.UI/js/Video/Ox.SmallVideoTimeline.js @@ -3,7 +3,6 @@ /*@ Ox.SmallVideoTimeline Small Video Timeline @*/ - Ox.SmallVideoTimeline = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Video/Ox.SmallVideoTimelineImage.js b/source/Ox.UI/js/Video/Ox.SmallVideoTimelineImage.js index 4f0e0baa..78e6922f 100644 --- a/source/Ox.UI/js/Video/Ox.SmallVideoTimelineImage.js +++ b/source/Ox.UI/js/Video/Ox.SmallVideoTimelineImage.js @@ -1,5 +1,11 @@ 'use strict'; +/*@ +Ox.SmallVideoTimelineImage Small Video Timeline Image + (options[, self]) -> Small Video Timeline Image + options Options + self Shared private variable +@*/ Ox.SmallVideoTimelineImage = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Video/Ox.VideoEditor.js b/source/Ox.UI/js/Video/Ox.VideoEditor.js index d61e9bfa..fb599774 100644 --- a/source/Ox.UI/js/Video/Ox.VideoEditor.js +++ b/source/Ox.UI/js/Video/Ox.VideoEditor.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -1409,6 +1407,10 @@ Ox.VideoEditor = function(options, self) { self.$annotationPanel.addItem(layer, annotation); }; + /*@ + updateAnnotation updateAnnotation + (id, annotation) -> update annotation with id + @*/ that.updateAnnotation = function(id, annotation) { // called from editannotation callback self.options.selected = annotation.id; // fixme: needed? diff --git a/source/Ox.UI/js/Video/Ox.VideoEditorPlayer.js b/source/Ox.UI/js/Video/Ox.VideoEditorPlayer.js index e6062f54..7d77782d 100644 --- a/source/Ox.UI/js/Video/Ox.VideoEditorPlayer.js +++ b/source/Ox.UI/js/Video/Ox.VideoEditorPlayer.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Video/Ox.VideoElement.js b/source/Ox.UI/js/Video/Ox.VideoElement.js index ce9e40cc..20735a0f 100644 --- a/source/Ox.UI/js/Video/Ox.VideoElement.js +++ b/source/Ox.UI/js/Video/Ox.VideoElement.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Video/Ox.VideoPanel.js b/source/Ox.UI/js/Video/Ox.VideoPanel.js index e559593b..92ab98e2 100644 --- a/source/Ox.UI/js/Video/Ox.VideoPanel.js +++ b/source/Ox.UI/js/Video/Ox.VideoPanel.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ diff --git a/source/Ox.UI/js/Video/Ox.VideoPlayer.js b/source/Ox.UI/js/Video/Ox.VideoPlayer.js index f1228f1d..7f5bb4b5 100644 --- a/source/Ox.UI/js/Video/Ox.VideoPlayer.js +++ b/source/Ox.UI/js/Video/Ox.VideoPlayer.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -2391,6 +2389,10 @@ Ox.VideoPlayer = function(options, self) { } }; + /*@ + changeVolume change volume + (num) -> change volume + @*/ that.changeVolume = function(num) { changeVolume(num); return that; diff --git a/source/Ox.UI/js/Video/Ox.VideoPreview.js b/source/Ox.UI/js/Video/Ox.VideoPreview.js index 37497569..d0a86533 100644 --- a/source/Ox.UI/js/Video/Ox.VideoPreview.js +++ b/source/Ox.UI/js/Video/Ox.VideoPreview.js @@ -1,7 +1,11 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; +/*@ +Ox.VideoPreview Video Preview + (options[, self]) -> Video Preview + options Options + self Shared private variable +@*/ Ox.VideoPreview = function(options, self) { self = self || {}; diff --git a/source/Ox.UI/js/Video/Ox.VideoTimelinePanel.js b/source/Ox.UI/js/Video/Ox.VideoTimelinePanel.js index 8b422136..4fe83539 100644 --- a/source/Ox.UI/js/Video/Ox.VideoTimelinePanel.js +++ b/source/Ox.UI/js/Video/Ox.VideoTimelinePanel.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -280,10 +278,14 @@ Ox.VideoTimelinePanel = function(options, self) { } }; + /*@ + toggleAnnotations toggle annotations + () -> toggle annotations + @*/ that.toggleAnnotations = function() { that.$element.toggle(1); }; return that; -}; \ No newline at end of file +}; diff --git a/source/Ox.UI/js/Video/Ox.VideoTimelinePlayer.js b/source/Ox.UI/js/Video/Ox.VideoTimelinePlayer.js index 8b838d5b..fb80e877 100644 --- a/source/Ox.UI/js/Video/Ox.VideoTimelinePlayer.js +++ b/source/Ox.UI/js/Video/Ox.VideoTimelinePlayer.js @@ -1,7 +1,11 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; +/*@ +Ox.VideoTimelinePlayer Video Timeline Player + (options[, self]) -> Video Timeline Player + options Options + self Shared private variable +@*/ Ox.VideoTimelinePlayer = function(options, self) { self = self || {}; @@ -802,6 +806,10 @@ Ox.VideoTimelinePlayer = function(options, self) { } }; + /*@ + togglePaused toggle paused + () -> toggle paused + @*/ that.togglePaused = function() { togglePaused(); return that; diff --git a/source/Ox.UI/js/Window/Ox.Dialog.js b/source/Ox.UI/js/Window/Ox.Dialog.js index 5d9ea2a3..e8c5fdea 100644 --- a/source/Ox.UI/js/Window/Ox.Dialog.js +++ b/source/Ox.UI/js/Window/Ox.Dialog.js @@ -1,5 +1,5 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript 'use strict'; + /*@ Ox.Dialog Dialog object () -> Dialog object @@ -637,6 +637,10 @@ Ox.Dialog = function(options, self) { } }; + /*@ + close close + (callback) -> close + @*/ that.close = function(callback) { if (self.isOpen) { self.isOpen = false; @@ -661,28 +665,48 @@ Ox.Dialog = function(options, self) { return that; }; + /*@ + disableButton disable button + (id) -> disable button + @*/ that.disableButton = function(id) { getButtonById(id).options({disabled: true}); return that; }; + /*@ + disableButtons disable buttons + () -> disable all buttons + @*/ that.disableButtons = function() { self.options.buttons.forEach(function(button) { !Ox.isEmpty(button) && button.options({disabled: true}); }); }; + /*@ + enableButton enable button + (id) -> enable button + @*/ that.enableButton = function(id) { getButtonById(id).options({disabled: false}); return that; }; + /*@ + enableButtons enable buttons + () -> enable all buttons + @*/ that.enableButtons = function() { self.options.buttons.forEach(function(button) { !Ox.isEmpty(button) && button.options({disabled: false}); }); }; + /*@ + open open + () -> open dialog + @*/ that.open = function() { if (!self.isOpen) { self.isOpen = true; @@ -719,6 +743,10 @@ Ox.Dialog = function(options, self) { return that; }; + /*@ + setSize set size + (width, height) -> set size + @*/ that.setSize = function(width, height) { self.options.width = width; self.options.height = height; @@ -734,6 +762,7 @@ Ox.Dialog = function(options, self) { width: self.options.width, height: self.options.height }); + return that; }; return that; diff --git a/source/Ox.UI/js/Window/Ox.Layer.js b/source/Ox.UI/js/Window/Ox.Layer.js index 257408bd..462c4678 100644 --- a/source/Ox.UI/js/Window/Ox.Layer.js +++ b/source/Ox.UI/js/Window/Ox.Layer.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -37,6 +35,10 @@ Ox.Layer = function(options, self) { that.stop().animate({opacity: 0}, 250); } + /*@ + hide hide + () -> hide layer + @*/ that.hide = function() { if (self.options.type == 'dialog') { Ox.UI.$window.unbind({mouseup: mouseup}); @@ -44,6 +46,10 @@ Ox.Layer = function(options, self) { that.remove(); }; + /*@ + show show + () -> show layer + @*/ that.show = function() { if (self.options.type == 'dialog') { Ox.UI.$window.bind({mouseup: mouseup}); @@ -54,4 +60,4 @@ Ox.Layer = function(options, self) { return that; -} \ No newline at end of file +} diff --git a/source/Ox.UI/js/Window/Ox.Tooltip.js b/source/Ox.UI/js/Window/Ox.Tooltip.js index 2e013423..6eb6dff1 100644 --- a/source/Ox.UI/js/Window/Ox.Tooltip.js +++ b/source/Ox.UI/js/Window/Ox.Tooltip.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - 'use strict'; /*@ @@ -34,6 +32,10 @@ Ox.Tooltip = function(options, self) { } }; + /*@ + hide hide tooltip + () -> hide tooltip + @*/ that.hide = function() { var last = Ox.last(arguments); if (self.options.title) { @@ -53,6 +55,10 @@ Ox.Tooltip = function(options, self) { // can pass event instead of x/y // fixme: use this in widgets + /*@ + show show tooltip + (x, y) -> show tooltip at x,y + @*/ that.show = function(x, y) { var last = Ox.last(arguments), left, top, width, height; diff --git a/source/Ox/js/Core.js b/source/Ox/js/Core.js index 0dc98bdd..f2f87fbb 100644 --- a/source/Ox/js/Core.js +++ b/source/Ox/js/Core.js @@ -1,5 +1,3 @@ -// vim: et:ts=4:sw=4:sts=4:ft=javascript - // OxJS (c) 2012 0x2620, dual-licensed GPL/MIT, see http://oxjs.org for details 'use strict';