lsd_rails 0.1

data/Packages/mootools-more/Docs/Interface/HtmlTable.Select.md

@@ -0,0 +1,246 @@
+Class: HtmlTable.Select {#HtmlTable}
+====================================
+
+Adds the ability to select rows in a table.
+
+### Refactors
+
+* [HtmlTable][]
+
+
+HtmlTable Method: constructor
+-----------------------------
+
+### Syntax
+
+	new HtmlTable([table, options]);
+
+### Arguments
+
+1. table - (*mixed*; optional) - a Table DOM element or it's id; if you do not specify one, one will be created.
+1. options - (*object*; optional) a key/value set of options.
+
+### Options
+
+* all options defined by [HtmlTable][], plus:
+* classZebra - (*string*) the class added to odd numbered rows; defaults to 'table-tr-odd'
+* useKeyboard - (*boolean*) if *true* (the default) allows for the use of arrows to navigate rows and *enter* to select them.
+* classRowSelected - (*string*) the class to add to the tr that is selected; defaults to 'table-tr-selected'
+* classRowHovered - (*string*) the class to add to the tr that is hovered over by the mouse or has focus with the keyboard; defaults to 'table-tr-hovered'
+* classSelectable - (*string*) the class to add to the table when selection is enabled; defaults to 'table-selectable'
+* selectable - (*boolean*) if *true* the rows will be selectable. Defaults to *false*.
+* allowMultiSelect - (*boolean*) if *true* (the default) the user can select more than one row at a time.
+* shiftForMultiSelect - (*boolean*) enables support for holding shift to multi-select files (defaults to *false*). If *false* (and `allowMultiSelect` is *true*), clicking any row selects it.
+* selectHiddenRows - (*boolean*) if *false* (the default), the selection logic ignores hidden rows, as if they were not in the DOM.
+
+### Events
+
+* rowFocus - callback to execute when a row is selected; passed the *tr* of the selected row, and the collection of selected rows
+* rowUnfocus - callback to execute when a row is deselected; passed the *tr* of the unselected row, and the collection of selected rows
+
+### Example
+
+	var myTable = new HtmlTable({
+		properties: {
+			border: 1,
+			cellspacing: 3
+		},
+		rows: [
+			['apple', 'red'],
+			['lemon', 'yellow']
+		],
+		selectable: true
+	});
+	myTable.inject($('someContainer'));
+
+HtmlTable method: enableSelect {#HtmlTable:enableSelect}
+------------------------------------------
+
+Enables selection of rows.
+
+### Syntax
+
+	myTable.enableSelect();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: disableSelect {#HtmlTable:disableSelect}
+------------------------------------------
+
+Disables selection of rows.
+
+### Syntax
+
+	myTable.disableSelect();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: toggleRow {#HtmlTable:toggleRow}
+------------------------------------------
+
+Toggles the selected state of a row.
+
+### Syntax
+
+	myTable.toggleRow(trElement);
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: selectRow {#HtmlTable:selectRow}
+------------------------------------------
+
+Selects a row.
+
+### Syntax
+
+	myTable.selectRow(trElement);
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: deselectRow {#HtmlTable:deslectRow}
+------------------------------------------
+
+Selects a row.
+
+### Syntax
+
+	myTable.deselectRow(trElement);
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: isSelected {#HtmlTable:isSelected}
+------------------------------------------
+
+Returns the selected state of a row element.
+
+### Syntax
+
+	myTable.isSelected(trElement);
+
+### Returns
+
+* (*boolean*) *true* if the row is selected.
+
+HtmlTable method: getSelected {#HtmlTable:getSelected}
+------------------------------------------
+
+Returns an array of rows that are selected.
+
+### Syntax
+
+	myTable.getSelected();
+
+### Returns
+
+* (*array*) an array of TR elements that are selected.
+
+
+HtmlTable method: selectRange {#HtmlTable:selectRange}
+------------------------------------------
+
+Selects a group of rows.
+
+### Syntax
+
+	myTable.selectRange(startRow, endRow);
+
+### Arguments
+
+* startRow - (*mixed*) the TR element that starts the selection or an integer of its index in the rows in the table body.
+* endRow - (*mixed*) the TR element that ends the selection or an integer of its index in the rows in the table body.
+
+### Note
+
+The actual order of the start and end rows doesn't matter. The range is selected even if the end row is before the start row.
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: deselectRange {#HtmlTable:deselectRange}
+------------------------------------------
+
+Deselects a group of rows.
+
+### Syntax
+
+	myTable.deselectRange(startRow, endRow);
+
+### Arguments
+
+* startRow - (*element*) the TR element that starts the deselection.
+* endRow - (*element*) the TR element that ends the deselection.
+
+### Note
+
+The actual order of the start and end rows doesn't matter. The range is deselected even if the end row is before the start row.
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable Method: selectAll {#HtmlTable:selectAll}
+--------------------------------------------------
+
+Selects all rows
+
+### Syntax
+
+	myHtmlTable.selectAll();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable Method: selectNone {#HtmlTable:selectNone}
+--------------------------------------------------
+
+Deselects all rows
+
+### Syntax
+
+	myHtmlTable.selectNone();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+
+HtmlTable Method: serialize {#HtmlTable:serialize}
+----------------------------------------
+
+Return an object storing the select state of the table.
+
+### Syntax
+
+          myTable.serialize();
+
+### Returns
+
+* (*object*) Object containing select state of the table. 
+
+
+HtmlTable Method: restore {#HtmlTable:restore}
+----------------------------------------
+
+Restores the select state of the table from an object passed in.
+
+### Syntax
+
+          myTable.restore(tableState);
+
+### Arguments
+
+1. tableState - Object created by HtmlTable.serialize() which contains the select state of the table.
+
+[HtmlTable]: /more/Interface/HtmlTable

data/Packages/mootools-more/Docs/Interface/HtmlTable.Sort.md

@@ -0,0 +1,193 @@
+Class: HtmlTable.Sort {#HtmlTable}
+==================================
+
+Makes headers of HtmlTable clickable to sort the rows.
+
+### Refactors
+
+* [HtmlTable][]
+
+
+HtmlTable Method: constructor
+-----------------------------
+
+### Syntax
+
+	new HtmlTable([table, options]);
+
+### Arguments
+
+1. table - (*mixed*; optional) - a Table DOM element or it's id; if you do not specify one, one will be created.
+2. options - (*object*; optional) a key/value set of options.
+
+### Options
+
+* all options defined by [HtmlTable][], plus:
+* sortIndex - (*number*) the row to sort on startup; defaults to *0*. Set to *null* if you don't want to sort on startup.
+* sortReverse - (*boolean*) if *true*, the initial sorted row will be sorted in reverse. Defaults to *false*.
+* parsers - (*array*) a mapping of parsers for each column of data. See section on parsers below.
+* defaultParser - (*string*) if no parsers are defined and they cannot be auto detected, which parser to use; defaults to 'string'
+* classSortable - (*string*) the class to add to the table when sorting is enabled; defaults to 'table-sortable'
+* classHeadSort - (*string*) the class to add to the th that has the current sort (applied when sort order is forward); defaults to 'table-th-sort'
+* classHeadSortRev - (*string*) the class to add to the th that has the current sort (applied when sort order is reverse); defaults to 'table-th-sort-rev',
+* classNoSort - (*string*) if a th has this class, it will not be sortable; defaults to 'table-th-nosort'
+* classGroup - (*string*) class applied to td elements when more than one has the same value; defaults to 'table-tr-group',
+* classGroupHead - (*string*) class applied to the *first* td in a group of td elements that have the same value; defaults to 'table-tr-group-head'
+* classCellSort - (*string*) the class applied to td elements that are in the current sorted column. defaults to 'table-td-sort'
+* classSortSpan - (*string*) the class applied to a span element injected into the th headers when sorting is enabled; useful for adding an arrow background for the sorted column to indicate the sort direction. defaults to 'table-th-sort-span'
+* sortable - (*boolean*) enables the sortable feature on invocation. Defaults to *false*.
+* thSelector - (*string* defaults to 'th') the string selector used in delegating sort events.
+
+### Events
+
+* sort - callback executed when a column is sorted; passed the *tbody* and the index of the column sorted.
+
+### Note
+
+Your Table must have a *thead* with *th* elements for each column (these are what the user clicks on to sort stuff). If your table doesn't have headers already, you can specify them with the *headers* option or use the *setHeaders* method.
+
+
+HtmlTable Method: sort {#HtmlTable:sort}
+----------------------------------------
+
+Sorts a column.
+
+### Syntax
+
+	myHtmlTable.sort(index, reverse, prepare);
+
+### Arguments
+
+1. index - (*number*) the index of the column to sort
+2. reverse - (*boolean*) reverses the sort if *true*; defaults to *false*
+3. prepare - (*boolean*) if the sort has a secondary sort, set this value to *true* on the first sort, and *false* on the second. For example, if you sorted a directory list of files first by type and then secondly by file size, you would sort on type and pass *true* and then sort on size and pass *false*.
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: enableSort {#HtmlTable:enableSort}
+----------------------------------------------------
+
+Enables the sortable features of the table.
+
+### Syntax
+
+	myTable.enableSort();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: disableSort {#HtmlTable:disableSort}
+------------------------------------------------------
+
+Disables the sortable features of the table.
+
+### Syntax
+
+	myTable.disableSort();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: reSort {#HtmlTable:reSort}
+--------------------------------------------
+
+Reapplies the current sort. Note that this is called whenever new rows are added.
+
+### Syntax
+
+	myTable.reSort();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable Method: serialize {#HtmlTable:serialize}
+----------------------------------------
+
+Return an object storing the sort state of the table.
+
+### Syntax
+
+          myTable.serialize();
+
+### Returns
+
+* (*object*) Object containing sort state of the table. 
+
+
+HtmlTable Method: restore {#HtmlTable:restore}
+----------------------------------------
+
+Restores the sort state of the table from an object passed in.
+
+### Syntax
+
+          myTable.restore(tableState);
+
+### Arguments
+
+1. tableState - Object created by HtmlTable.serialize() which contains the sort state of the table.
+
+
+Object: HtmlTable.Parsers {#HtmlTable:Parsers}
+==============================================
+
+There are numerous parsers used by HtmlTable to determine the sort order of data. A column of numbers, for example, will be sorted numerically, while a column of dates will be sorted by their date order. The HtmlTable.Parsers object contains a group of objects each with a regular expression and a function applied when that expression matches the content.
+
+### Example
+
+	HtmlTable.Parsers.number = {
+		match: /^\d+[^\d.,]*$/,
+		convert: function() {
+			return this.get('text').toInt();
+		},
+		number: true
+	};
+
+### Properties
+
+* match - (*regular expression*) Used when autodetecting the type of a particular table value.
+* convert - (*function*) Executed on a particular table cells to parse its value for sorting. The value returned by this function is the value sorted against. The context of this function refers to a particular table cell. This will not update your table cell's html.
+* number - (*boolean*; optional) Numerical parsers should have this flag for proper sorting.
+
+Included Parsers
+----------------
+
+* date - sorts for date formats that are matched by [Date.parse][]
+* input-checked - sorts checkbox inputs into those that are checked and are not checked
+* input-value - sorts based on the value inside text inputs
+* number - sorts on integers
+* numberLax - sorts on integer values that might be mixed with other data.
+* float - sorts on float values
+* floatLax - sorts on float values that might contain other data.
+* string - an alpha sort
+* title - sorts on the *title* property of the table data element
+
+Array: HtmlTable.ParserPriority {#HtmlTable:ParserPriority}
+-----------------------------------------------------------
+
+HtmlTable.ParserPriority is an array of parser names which define the priority in which your table data is evaluated for sorting. By default it is defined to test from most specific parser to most general. The default ordering is:
+
+	HtmlTable.ParserPriority = ['date', 'input-checked', 'input-value', 'float', 'number']; //if no match, defaults to string
+
+Static Method: HtmlTable.defineParsers {#HtmlTable:defineParsers}
+-----------------------------------------------------------------
+
+Because HtmlTable.Parsers are run in the order defined by the HtmlTable.ParserPriority above, merely defining a custom parser on the HtmlTable.Parser object will produce no results. Therefore this is a static method which will both define your parser on the HtmlTable.Parser namespace as well as add your parser to the top of the HtmlTable.ParserPriority list.
+
+### Syntax
+
+	HtmlTable.defineParsers({
+		foo: {
+			match: /foo/,
+			convert: function(){...},
+			number: false
+		}
+	});
+
+[HtmlTable]: /more/Interface/HtmlTable
+[Date.parse]: /more/Types/Date#Date:parse

data/Packages/mootools-more/Docs/Interface/HtmlTable.Zebra.md

@@ -0,0 +1,94 @@
+Class: HtmlTable.Zebra {#HtmlTable:Zebra}
+=========================================
+
+Adds stripes to an instance of HtmlTable.
+
+### Refactors
+
+* [HtmlTable][]
+
+
+HtmlTable Method: constructor
+-----------------------------
+
+### Syntax
+
+	new HtmlTable([table, options]);
+
+### Arguments
+
+1. table - (*mixed*; optional) - a Table DOM element or it's id; if you do not specify one, one will be created.
+1. options - (*object*; optional) a key/value set of options.
+
+### Options
+
+* all options defined by [HtmlTable][], plus:
+* classZebra - (*string*) the class added to odd numbered rows; defaults to 'table-tr-odd'
+* zebra - (*boolean*) if *true* adds the *classZebra* value to odd numbered rows.
+
+### Example
+
+	var myTable = new HtmlTable({
+		properties: {
+			border: 1,
+			cellspacing: 3
+		},
+		rows: [
+			['apple', 'red'],
+			['lemon', 'yellow']
+		],
+		zebra: true
+	});
+	myTable.inject($('someContainer'));
+
+HtmlTable Method: updateZebras {#HtmlTable:updateZebras}
+--------------------------------------------------------
+
+Updates the rows, reapplying the odd class names.
+
+### Syntax
+
+	myHtmlTable.updateZebras();
+
+
+### Returns
+
+* (*object*) an object containing the tr and td tags.
+
+### Example of Object Returned
+
+	{tr: theTableRow, tds: [td, td, td]}
+
+HtmlTable method: empty {#HtmlTable:empty}
+------------------------------------------
+
+Empties the *tbody* of the table.
+
+### Syntax
+
+	myTable.empty();
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+HtmlTable method: setHeaders {#HtmlTable:setHeaders}
+----------------------------------------------------
+
+Sets the contents of the *thead* with *th* tags.
+
+### Syntax
+
+	myTable.setHeaders(headers);
+
+### Arguments
+
+1. headers - (*array*) an array of header information; same as the row data sent to [HtmlTable.push][]
+
+### Returns
+
+* (*object*) This instance of HtmlTable.
+
+[HtmlTable]: /more/Interface/HtmlTable
+[HtmlTable.push]: /more/Interface/HtmlTable#HtmlTable:push
+