diff --git a/source/Ox.UI/js/Core/App.js b/source/Ox.UI/js/Core/App.js index 18843609..08f8c6bc 100644 --- a/source/Ox.UI/js/Core/App.js +++ b/source/Ox.UI/js/Core/App.js @@ -2,8 +2,7 @@ /*@ Ox.App Basic application instance that communicates with a JSON API - () -> App object - (options) -> App object + ([options]) -> App object options Options object timeout request timeout type HTTP Request type, i.e. 'GET' or 'POST' diff --git a/source/Ox.UI/js/List/List.js b/source/Ox.UI/js/List/List.js index ef3bcb66..7a3b0d89 100644 --- a/source/Ox.UI/js/List/List.js +++ b/source/Ox.UI/js/List/List.js @@ -1,18 +1,14 @@ 'use strict'; /*@ -Ox.List List Element - ([options[, self]]) -> List Object +Ox.List List constructor options Options object - centered if true, and orientation is 'horizontal', - then keep the selected item centered + centered if true, and orientation is 'horizontal', then keep the selected item centered construct (data) returns the list item HTML draggable If true, items can be dragged format <[]> ??? itemHeight item height - items list of items, - (data) returns {items, size, ...} - (data, callback) returns [items] + items list of items, (data) returns {items, size, ...}, (data, callback) returns [items] itemWidth item width keys keys of the list items max Maximum number of items that can be selected (-1 for all) @@ -22,25 +18,26 @@ Ox.List List Element selected ids of the selected elements sort sort order sortable If true, items can be re-ordered - sums <[]|[]> sums to be included in totals - type + sums <[s]|[]> sums to be included in totals + type type unique name of the key that acts as unique id self shared private variable - add item added - delete item removed - draganddrop Fires during drag - draganddropend Fires on drop - draganddropenter Fires when entering an item during drag - draganddropleave Fires when leaving an item during drag - draganddroppause Fires when the mouse stops during drag - draganddropstart Fires when drag starts - copy copy - paste paste - move move item - load list loaded - openpreview preview of selected item opened - closepreview preview closed - select select item + ([options[, self]]) -> List object + add item added + delete item removed + draganddrop Fires during drag + draganddropend Fires on drop + draganddropenter Fires when entering an item during drag + draganddropleave Fires when leaving an item during drag + draganddroppause Fires when the mouse stops during drag + draganddropstart Fires when drag starts + copy copy + paste paste + move move item + load list loaded + openpreview preview of selected item opened + closepreview preview closed + select select item @*/ // fixme: rename the add event to new, or the delete event to remove diff --git a/source/Ox.UI/js/List/TextList.js b/source/Ox.UI/js/List/TextList.js index c7494c52..4add27c8 100644 --- a/source/Ox.UI/js/List/TextList.js +++ b/source/Ox.UI/js/List/TextList.js @@ -2,7 +2,7 @@ /*@ Ox.TextList TextList Object - ([options[, self]]) -> TextList Object + ([options[, self]]) -> TextList Object options Options object columns <[o]|[]> Columns # Fixme: There's probably more... @@ -25,17 +25,17 @@ Ox.TextList TextList Object columnsVisible If true, columns are visible columnWidth <[n]|[40, 800]> Minimum and maximum column width draggable If true, items can be dragged - id + id Id items function() {} {sort, range, keys, callback} or array keys <[s]|[]> Additional keys (apart from keys of visible columns) max Maximum number of items that can be selected (-1 for all) min Minimum number of items that must be selected pageLength Number of items per page scrollbarVisible If true, the scrollbar is always visible - selected - sort <[]|[]> + selected <[s]|[]> Array of selected ids + sort <[o]|[s]|[]> ['+foo', ...] or [{key: 'foo', operator: '+'}, ...] sortable If true, elements can be re-ordered - sums <[]|[]> Sums to be included in totals + sums <[s]|[]> Sums to be included in totals self shared private variable @*/ diff --git a/source/Ox/js/Core.js b/source/Ox/js/Core.js index 2a36f739..a35be326 100644 --- a/source/Ox/js/Core.js +++ b/source/Ox/js/Core.js @@ -137,8 +137,8 @@ Ox.load = function() { }; /*@ -Ox.localStorage localStorage wrapper - (namespace) -> localStorage object for a given namespace +Ox.localStorage localStorage wrapper + (namespace) -> storage localStorage function for a given namespace FIXME: there is a bug in Ox.doc here, will use "(namespace)" as function name () -> returns all key:value pairs