lsd_rails 0.1

data/Packages/mootools-core/Docs/Core/Core.md

@@ -0,0 +1,385 @@
+# Type: Core {#Core}
+
+Core contains common functions used in [MooTools][].
+
+## Function: typeOf {#Core:typeOf}
+
+Returns the type of an object.
+
+### Syntax:
+
+	typeOf(obj);
+
+### Arguments:
+
+1. obj - (*object*) The object to inspect.
+
+### Returns:
+
+* 'element'    - (*string*) If object is a DOM element node.
+* 'elements'   - (*string*) If object is an instance of [Elements][].
+* 'textnode'   - (*string*) If object is a DOM text node.
+* 'whitespace' - (*string*) If object is a DOM whitespace node.
+* 'arguments'  - (*string*) If object is an arguments object.
+* 'array'      - (*string*) If object is an array.
+* 'object'     - (*string*) If object is an object.
+* 'string'     - (*string*) If object is a string.
+* 'number'     - (*string*) If object is a number.
+* 'date'       - (*string*) If object is a date.
+* 'boolean'    - (*string*) If object is a boolean.
+* 'function'   - (*string*) If object is a function.
+* 'regexp'     - (*string*) If object is a regular expression.
+* 'class'      - (*string*) If object is a [Class][] (created with new Class or the extend of another class).
+* 'collection' - (*string*) If object is a native HTML elements collection, such as childNodes or getElementsByTagName.
+* 'window'     - (*string*) If object is the window object.
+* 'document'   - (*string*) If object is the document object.
+* 'event'      - (*string*) If object is an event.
+* 'null'       - (*boolean*) If object is undefined, null, NaN or none of the above.
+
+### Example:
+
+	var myString = 'hello';
+	typeOf(myString); // returns "string"
+
+### Note:
+
+This method is equivalent to *$type* from MooTools 1.2, with the exception that undefined and null values now return 'null' as a string, instead of false.
+
+## Function: instanceOf {#Core:instanceOf}
+
+Checks if an object is an instance of a particular type.
+
+### Syntax:
+
+	instanceOf(item, object)
+
+### Arguments:
+
+1. item - (*mixed*) The item to check.
+2. object - (*mixed*) The type to compare it with.
+
+### Returns:
+
+* (*boolean*) Whether or not the item is an instance of the object.
+
+### Examples:
+
+	var foo = [];
+	instanceOf(foo, Array) // returns true
+	instanceOf(foo, String) // returns false
+
+	var myClass = new Class();
+	var bar = new myClass();
+	instanceOf(bar, myClass) // returns true
+
+### Type {#Type}
+
+MooTools extends native types, like string, array or number to make them even more useful.
+
+The types MooTools uses are:
+
+- String
+- Array
+- Number
+- Function
+- RegExp
+- Date
+- Boolean
+
+Custom MooTools types are:
+
+- Element
+- Elements
+- Event
+
+## Type method: implement {#Type:implement}
+
+This method implements a new method to the type's prototype.
+
+### Syntax:
+
+	myType.implement(name, method);
+
+**or**
+
+	myType.implement(methods);
+
+### Arguments:
+
+1. name - (*string*) The method name.
+2. method - (*function*) The method function.
+
+**or**
+
+1. methods - (*object*) An object with key-value pairs. The key is the method name, the value is the method function.
+
+### Returns:
+
+* (*object*) The type.
+
+### Examples:
+
+	Array.implement('limitTop', function(top){
+		for (var i = 0, l = this.length; i < l; i++){
+			if (this[i] > top) this[i] = top;
+		}
+		return this;
+	});
+
+	[1, 2, 3, 4, 5, 6].limitTop(4); // returns [1, 2, 3, 4, 4, 4]
+
+It is also possible to pass an object of methods:
+
+	String.implement({
+		repeat: function(times){
+			var string = '';
+			while (times--) string += this;
+			return string;
+		},
+		ftw: function(){
+			return this + ' FTW!';
+		}
+	});
+
+	'moo! '.repeat(3); // returns "moo! moo! moo! "
+	'MooTools'.ftw(); // returns "MooTools FTW!"
+	('MooTools'.ftw() + ' ').repeat(2); // returns "MooTools FTW! MooTools FTW! "
+
+## Type method: extend {#Type:extend}
+
+Adds one or more functions to the type. These are static functions that accept for example other types to parse them into the type, or other utility functions that belong to the certain type.
+
+### Syntax:
+
+	myType.extend(name, method);
+
+**or**
+
+	myType.extend(methods);
+
+### Arguments:
+
+1. name - (*string*) The method name.
+2. method - (*function*) The method function.
+
+**or**
+
+1. methods - (*object*) An object with key-value pairs. The key is the method name, the value is the method function.
+
+### Returns:
+
+* (*object*) The type.
+
+### Examples:
+
+	RegExp.extend('from', function(regexp, flags){
+		return new RegExp(regexp, flags);
+	});
+
+	Number.extend('parseCurrency', function(currency){
+		// takes a string and transforms it into a number to
+		// do certain calculations
+	});
+
+## Generics {#Type:generics}
+
+Most methods of types can be used as generic functions. These are the already existing JavaScript methods, methods MooTools adds, or methods you [implemented][implement] yourself.
+
+### Example:
+
+	var everyArgBiggerThanTwo = function(){
+		// Instead of this
+		return Array.prototype.every.call(arguments, someFunction);
+		// you can use
+		return Array.every(arguments, someFunction);
+	};
+
+This is useful if methods of a certain type should be used as function of another type.
+ As the example above, it is used for the Arguments type, which is not a real array, so `arguments.every(fn)` would not work. However, `Array.every(arguments, fn)` does work in MooTools.
+
+### Syntax:
+
+	Type.methodName(thisArg[, arg1, arg2, ...]);
+
+### Arguments:
+
+1. thisArg - (*mixed*) This is the subject, which is usually `thisArg.method([arg1, arg2, ...]);`.
+2. arg1, arg2, ... - (*mixed*) Additional arguments which will be passed as method arguments.
+
+### Returns:
+
+- (*mixed*) Anything the method usually returns.
+
+[Class]: /core/Class/Class
+[Elements]: /core/Element/Element
+[implement]: core/Core/Core#Type:implement
+[MooTools]: http://mootools.net
+
+---
+
+Deprecated Functions {#Deprecated-Functions}
+============================================
+
+
+Function: $chk {#Deprecated-Functions:chk}
+---------------------
+
+This method has been deprecated and will have no equivalent in MooTools 1.3.
+
+If you really need this function you can implement it like so:
+
+### Example:
+
+	var $chk = function(obj){
+		return !!(obj || obj === 0);
+	};
+
+
+
+Function: $clear {#Deprecated-Functions:clear}
+-------------------------
+
+This method has been deprecated. Please use *clearInterval* or *clearTimeout* instead.
+
+### See Also:
+
+- [MDC clearTimeout][], [MDC clearInterval][]
+
+
+Function: $defined {#Deprecated-Functions:defined}
+-----------------------------
+
+This method has been deprecated.
+
+If you really need this function you can implement it like so:
+
+### Example:
+
+	var $defined = function(obj){
+		return (obj != undefined);
+	};
+
+	// or just use it like this:
+	if(obj != undefined){
+		// do something
+	}
+
+
+Function: $arguments {#Deprecated-Functions:arguments}
+---------------------------------
+
+This method has been deprecated and will have no equivalent in MooTools 1.3.
+
+If you really need this function you can implement it like so:
+
+### Example:
+
+	var $arguments = function(i){
+		return function(){
+			return arguments[i];
+		};
+	};
+
+
+
+Function: $empty {#Deprecated-Functions:empty}
+-------------------------
+
+This method has been deprecated. Use [Function.from](/core/Types/Function#Function:Function-from) instead.
+
+### Example:
+
+	var myFunc = Function.from();
+	// or better:
+	var myFunc = function(){};
+
+
+
+Function: $lambda {#Deprecated-Functions:lambda}
+---------------------------
+
+This method has been deprecated. Use [Function.from](/core/Types/Function#Function:Function-from) instead.
+
+### Example:
+
+	myLink.addEvent('click', Function.from(false)); // prevents a link Element from being clickable
+
+
+
+Function: $extend {#Deprecated-Functions:extend}
+---------------------------
+
+This method has been deprecated. Please use [Object.append](/core/Types/Object#Object:Object-append) instead.
+
+
+
+Function: $merge {#Deprecated-Functions:merge}
+-------------------------
+
+This method has been deprecated. Please use [Object.merge](/core/Types/Object#Object:Object-merge) instead.
+
+
+
+Function: $each {#Deprecated-Functions:each}
+-----------------------
+
+This method has been deprecated. Please use [Array.each](/core/Types/Array#Array:Array-each) or [Object.each](/core/Types/Object#Object:Object-each) instead.
+
+
+
+Function: $pick {#Deprecated-Functions:pick}
+-----------------------
+
+This method has been deprecated. Please use [Array.pick](/core/Types/Array#Array:pick) instead.
+
+
+
+Function: $random {#Deprecated-Functions:random}
+---------------------------
+
+This method has been deprecated. Please use [Number.random](/core/Types/Number#Number:Number-random) instead.
+
+
+
+Function: $splat {#Deprecated-Functions:splat}
+-------------------------
+
+This method has been deprecated. Please use [Array.from](/core/Types/Array#Array:Array-from) instead.
+However `$splat` does *not* transform Array-like objects such as NodeList or FileList in arrays, `Array.from` does.
+
+
+Function: $time {#Deprecated-Functions:time}
+-----------------------
+
+This method has been deprecated. Please use *Date.now()* instead.
+
+### Syntax:
+
+	var time = Date.now();
+
+### Returns:
+
+* (*number*) - The current timestamp.
+
+
+
+Function: $try {#Deprecated-Functions:try}
+---------------------
+
+This method has been deprecated. Please use [Function.attempt](/core/Types/Function#Function:Function-attempt) instead.
+
+
+
+Function: $type {#Deprecated-Functions:type}
+-----------------------
+
+This method has been deprecated. Please use [typeOf](#Core:typeOf) instead.
+
+
+
+[Array]: /core/Types/Array
+[Function:bind]: /core/Types/Function/#bind
+[Function:delay]: /core/Types/Function/#delay
+[Function:periodical]: /core/Types/Function/#periodical
+[MDC clearInterval]: https://developer.mozilla.org/en/DOM/window.clearInterval
+[MDC clearTimeout]: https://developer.mozilla.org/en/DOM/window.clearTimeout

data/Packages/mootools-core/Docs/Element/Element.Dimensions.md

@@ -0,0 +1,235 @@
+Type: Element {#Element}
+=========================
+
+Custom Type to allow all of its methods to be used with any DOM element via the dollar function [$][].
+
+### Notes:
+
+* These methods don't take into consideration the body element margins and borders. If you need margin/borders on the body, consider adding a wrapper div, but always reset the margin and borders of body to 0.
+* If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
+
+### Credits:
+
+- Element positioning based on the [qooxdoo](http://qooxdoo.org/) code and smart browser fixes, [LGPL License](http://www.gnu.org/licenses/lgpl.html).
+- Viewport dimensions based on [YUI](http://developer.yahoo.com/yui/) code, [BSD License](http://developer.yahoo.com/yui/license.html).
+
+
+
+Element Method: scrollTo {#Element:scrollTo}
+--------------------------------------------
+
+Scrolls the element to the specified coordinated (if the element has an overflow).
+The following method is also available on the Window object.
+
+### Syntax:
+
+	myElement.scrollTo(x, y);
+
+### Arguments:
+
+1. x - (*number*) The x coordinate.
+2. y - (*number*) The y coordinate.
+
+### Example:
+
+	$('myElement').scrollTo(0, 100);
+
+### See Also:
+
+- [MDC Element:scrollLeft][], [MDC Element:scrollTop][]
+
+
+
+Element Method: getSize {#Element:getSize}
+------------------------------------------
+
+Returns the height and width of the Element, taking into account borders and padding.
+The following method is also available on the Window object.
+
+### Syntax:
+
+	myElement.getSize();
+
+### Returns:
+
+* (*object*) An object containing the width (as x) and the height (as y) of the target Element.
+
+### Example:
+
+	var size = myElement.getSize();
+	alert('The element is ' + size.x + ' pixels wide and ' + size.y + 'pixels high.');
+
+### Note:
+
+If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
+
+
+Element Method: getScrollSize {#Element:getScrollSize}
+------------------------------------------------------
+
+Returns an Object representing the size of the target Element, including scrollable area.
+The following method is also available on the Window object.
+
+### Syntax:
+
+	myElement.getScrollSize();
+
+### Returns:
+
+* (*object*) An object containing the x and y dimensions of the target Element.
+
+### Example:
+
+	var scroll = $('myElement').getScrollSize();
+	alert('My element can scroll to ' + scroll.y + 'px'); // alerts 'My element can scroll down to 820px'
+
+### See Also:
+
+- [MDC Element:scrollLeft][], [MDC Element:scrollTop][], [MDC Element:offsetWidth][], [MDC Element:offsetHeight][], [MDC Element:scrollWidth][], [MDC Element:scrollHeight][]
+
+### Note:
+
+If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
+
+
+Element Method: getScroll {#Element:getScroll}
+----------------------------------------------
+
+Returns an Object representing how far the target Element is scrolled in either direction.
+The following method is also available on the Window object.
+
+### Syntax:
+
+	myElement.getScroll();
+
+### Returns:
+
+* (*object*) An object containing the x and y dimensions of the target Element's scroll.
+
+### Example:
+
+	var scroll = $('myElement').getScroll();
+	alert('My element is scrolled down ' + scroll.y + 'px'); // alerts 'My element is scrolled down to 620px'
+
+### Note:
+
+If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
+
+
+Element Method: getPosition {#Element:getPosition}
+--------------------------------------------------
+
+Returns the real offsets of the element.
+
+### Syntax:
+
+	myElement.getPosition(relative);
+
+### Arguments:
+
+relative - (Element, defaults to the document) If set, the position will be relative to this Element.
+
+### Returns:
+
+* (*object*) An object with the x and y coordinates of the Element's position.
+
+### Example:
+
+	$('element').getPosition(); // returns {x: 100, y: 500};
+
+### See Also:
+
+- [QuirksMode: Find position](http://www.quirksmode.org/js/findpos.html)
+
+### Note:
+
+If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
+
+
+Element Method: setPosition {#Element:setPosition}
+--------------------------------------------------
+
+Sets the position of the element's *left* and *top* values to the x/y positions you specify.
+
+### Syntax
+
+	myElement.setPosition(positions);
+
+### Arguments
+
+1. positions - (*object*) an object with x/y values (integers or strings, i.e. 10 or "10px")
+
+### Returns
+
+* (*element*) the element that is positioned.
+
+### Example
+
+	myElement.setPosition({x: 10, y: 100});
+
+
+
+Element Method: getCoordinates {#Element:getCoordinates}
+--------------------------------------------------------
+
+Returns an object with width, height, left, right, top, and bottom coordinate values of the Element.
+
+### Syntax:
+
+	myElement.getCoordinates(relative);
+
+### Arguments:
+
+relative - (*element*, optional) if set, the position will be relative to this element, otherwise relative to the document.
+
+### Returns:
+
+* (*object*) An object containing the Element's current: top, left, width, height, right, and bottom.
+
+### Example:
+
+	var myValues = $('myElement').getCoordinates();
+
+#### Returns:
+
+	{
+		top: 50,
+		left: 100,
+		width: 200,
+		height: 300,
+		right: 300,
+		bottom: 350
+	}
+
+### See Also:
+
+[Element:getPosition](#Element:getPosition)
+
+### Note:
+
+If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
+
+
+Element Method: getOffsetParent {#Element:getOffsetParent}
+----------------------------------------------------------
+
+Returns the parent of the element that is positioned, if there is one.
+
+### Syntax
+
+	myElement.getOffsetParent();
+
+### Returns
+
+* (*mixed*) If the element has a parent that is positioned, it returns that element, otherwise it returns *null*.
+
+
+
+[$]: /core/Element/Element#Window:dollar
+[MDC Element:scrollLeft]: https://developer.mozilla.org/en/DOM/element.scrollLeft
+[MDC Element:scrollTop]: https://developer.mozilla.org/en/DOM/element.scrollTop
+[MDC Element:offsetWidth]: https://developer.mozilla.org/en/DOM/element.offsetWidth
+[MDC Element:offsetHeight]: https://developer.mozilla.org/en/DOM/element.offsetHeight
+[MDC Element:scrollWidth]: https://developer.mozilla.org/en/DOM/element.scrollWidth
+[MDC Element:scrollHeight]: https://developer.mozilla.org/en/DOM/element.scrollHeight
+[Element.measure]: /more/Element/Element.Measure