lsd_rails 0.1

data/Packages/mootools-more/Docs/Utilities/Assets.md

@@ -0,0 +1,175 @@
+Object: Asset {#Asset}
+======================
+
+Provides functions for the dynamic loading and management of JavaScript, CSS, and image files.
+
+
+
+Asset Function: javascript {#Asset:Asset-javascript}
+----------------------------------------------------
+
+Injects a script tag into the head section of the document, pointing to the src specified.
+
+### Syntax
+
+	var myScript = Asset.javascript(source[, properties]);
+
+### Arguments
+
+1. source     - (*string*) The location of the JavaScript file to load.
+2. properties - (*object*, optional) Additional attributes to be included into the script Element; this is the same as the second argument you might pass to including the Element constructor with the exception of Events (see note)
+   - onLoad   - (*function*) A function that will be invoked when the JavaScript is loaded.
+   - document - (*object*, defaults to `document`) The document which the JavaScript should be injected in.
+
+### Returns
+
+* (*element*) A new script Element.
+
+### Examples
+
+	var myScript = Asset.javascript('/scripts/myScript.js', {
+		id: 'myScript',
+		onLoad: function(){
+			alert('myScript.js is loaded!');
+		}
+	});
+
+### Note
+
+- WARNING: DO NOT use addEvent for load on the returned element, give it as onLoad in the properties argument.
+
+
+Asset Function: css {#Asset:Asset-css}
+--------------------------------------
+
+Injects a css file in the page.
+
+### Syntax
+
+	var myCSS = Asset.css(source[, properties]);
+
+### Arguments
+
+1. source     - (*string*) The path of the CSS file.
+2. properties - (*object*) Some additional attributes you might want to add to the link Element; this is the same as the second argument you might pass to including the Element constructor. For instance you might specify a title attribute or perhaps an id.
+   - document - (*object*, defaults to `document`) The document which the link element should be injected in.
+
+
+### Returns
+
+* (*element*) A new link Element.
+
+### Examples
+
+	var myCSS = Asset.css('/css/myStyle.css', {id: 'myStyle', title: 'myStyle'});
+
+
+Asset Function: image {#Asset:Asset-image}
+------------------------------------------
+
+Preloads an image and returns the img element.
+
+### Syntax
+
+	var myImage = Asset.image(source[, properties]);
+
+### Arguments
+
+1. source     - (*string*) The path of the image file.
+2. properties - (*object*) Some additional attributes you might want to add to the img Element.
+	- onLoad  - (*function*) A function that will be invoked when the image is loaded.
+	- onError - (*function*) A function that will be invoked when the image failed loading.
+	- onAbort - (*function*) A function what will be invoked when the loading is aborted.
+
+### Returns
+
+* (*element*) A new HTML img Element.
+
+### Examples
+
+	var myImage = Asset.image('/images/myImage.png', {
+		id: 'myImage',
+		title: 'myImage',
+		onLoad: myFunction
+	});
+
+### Notes
+
+- Does not inject the image into the page.
+- WARNING: DO NOT use addEvent for load/error/abort on the returned element, give them as onLoad/onError/onAbort in the properties argument.
+
+Asset Function: images {#Asset:Asset-images}
+--------------------------------------------
+
+Preloads an array of images (as strings) and returns an array of img elements. does not inject them to the page.
+
+### Syntax
+
+	var myImages = Asset.images(source[, options]);
+
+### Arguments
+
+1. sources - (*mixed*) An array or a string, of the paths of the image files.
+2. options - (*object*, optional) See below.
+
+### Options
+
+* properties - (*object*) Some additional attributes for all the images (same as the second argument you might pass to *Asset.image*).
+
+### Events
+
+#### complete
+
+* (*function*) Executes when all image files are loaded.
+
+##### Signature
+
+	onComplete()
+
+#### progress
+
+* (*function*) Executes when one image file is loaded.
+
+##### Signature
+
+	onProgress(counter, index, source)
+
+##### Arguments
+
+1. counter - (*number*) The number of loaded images.
+2. index   - (*number*) The index of the loaded image.
+3. source  - (*string*) The path of the image file.
+
+#### error
+
+* (*function*) Executes when one image file fails to load.
+
+##### Signature
+
+	onError(counter, index, source)
+
+##### Arguments
+
+1. counter - (*number*) The number of errored images.
+2. index   - (*number*) The index of the errored image.
+3. source  - (*string*) The path of the image file.
+
+### Returns
+
+* (*array*) An [Elements][] collection.
+
+### Examples
+
+	var myImages = Asset.images(['/images/myImage.png', '/images/myImage2.gif'], {
+		properties: {
+			'class': 'myImage',
+			title: 'myImage'
+		},
+		onComplete: function(){
+			alert('All images loaded!');
+		}
+	});
+
+
+
+[Elements]: /core/Element/Element#Elements

data/Packages/mootools-more/Docs/Utilities/Color.md

@@ -0,0 +1,276 @@
+Class: Color {#Color}
+=====================
+
+Creates a new Color Class, which is an array with some color specific methods.
+
+Color Method: constructor
+-------------------------
+
+### Syntax
+
+	var myColor = new Color(color[, type]);
+
+### Arguments
+
+1. color - (*mixed*) A string or an array representation of a color.
+2. type  - (*string*, optional) A string representing the type of the color to create.
+
+### Color
+
+There are three typical representations of color: String, RGB, and HSB. For String representation see [Element:setStyle][] for more information.
+
+### Examples
+
+##### String Representation
+
+	'#fff'
+
+##### RGB and HSB Representation
+
+	[255, 255, 255]
+	//Or:
+	[255, 255, 255, 1] //(For transparency.)
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	var black = new Color('#000');
+	var purple = new Color([255,0,255]);
+
+### Notes
+
+- For HSB colors, you need to specify the second argument.
+
+
+
+Color Method: mix {#Color:mix}
+------------------------------
+
+Mixes two or more colors with the Color.
+
+### Syntax
+
+	var myMix = myColor.mix(color[, color2[, color3[, ...][, alpha]);
+
+### Arguments
+
+1. color - (*mixed*) A single or many colors, in hex or rgb representation, to mix with this Color.
+2. alpha - (*number*, optional) If the last argument is a number, it will be treated as the amount of the color to mix.
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	// mix black with white and purple, each time at 10% of the new color
+	var darkpurple = new Color('#000').mix('#fff', [255, 0, 255], 10);
+
+	$('myDiv').setStyle('background-color', darkpurple);
+
+
+
+Color Method: invert {#Color:Invert}
+------------------------------------
+
+Inverts the Color.
+
+### Syntax
+
+	var myInvert = myColor.invert();
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	var white = new Color('#fff');
+	var black = white.invert();
+
+
+
+Color Method: setHue {#Color:setHue}
+------------------------------------
+
+Modifies the hue of the Color, and returns a new one.
+
+### Syntax
+
+	var hue = myColor.setHue(value);
+
+### Arguments
+
+1. value - (*number*) The hue to set.
+
+### Returns
+
+* (arrays) A new Color instance.
+
+### Example
+
+	var myColor = new Color('#f00');
+	var myElement = $('myElement');
+
+	(function(){
+		myElement.setStyle('color', myColor.setHue(myColor.hsb[0]++)));
+	}).periodical(250);
+
+
+
+Color Method: setSaturation {#Color:setSaturation}
+--------------------------------------------------
+
+Changes the saturation of the Color, and returns a new one.
+
+### Syntax
+
+	var saturate = myColor.setSaturation(percent);
+
+### Arguments
+
+1. percent - (*number*) The percentage of the saturation to set.
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	var myColor = new Color('#f00');
+	$('myElement').addEvent('mouseenter', function(){
+		this.setStyle('background-color', myColor.setSaturation(myColor.hsb[1]++));
+	});
+
+
+
+Color Method: setBrightness {#Color:setBrightness}
+--------------------------------------------------
+
+Changes the brightness of the Color, and returns a new one.
+
+### Syntax
+
+	var brighten = myColor.setBrightness(percent);
+
+### Arguments
+
+1. percent - (*number*) The percentage of the brightness to set.
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	var myColor = new Color('#000');
+	$('myElement').addEvent('mouseenter', function(){
+		this.setStyle('background-color', myColor.setBrightness(myColor.hsb[2]++));
+	});
+
+
+
+Function: $RGB {#RGB}
+---------------------
+
+Shortcut to create a new color, based on red, green, blue values.
+
+### Syntax
+
+	var myColor = $RGB(r, g, b);
+
+### Arguments
+
+1. r - (*number*) A red value from 0 to 255.
+2. g - (*number*) A green value from 0 to 255.
+3. b - (*number*) A blue value from 0 to 255.
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	var myColor = $RGB($random(0,255), $random(0,255), $random(0,255));
+
+
+
+Function: $HSB {#HSB}
+---------------------
+
+Shortcut to create a new color, based on: hue, saturation, brightness values.
+
+### Syntax
+
+	var myColor = $HSB(h, s, b);
+
+### Arguments
+
+1. h - (*number*) A hue value from 0 to 359.
+2. s - (*number*) A saturation value from 0 to 100.
+3. b - (*number*) A brightness value from 0 to 100.
+
+### Returns
+
+* (*array*) A new Color instance.
+
+### Examples
+
+	var myColor = $HSB(50, 50, 100);
+
+
+
+Type: Array {#Array}
+======================
+
+Contains Array prototypes.
+
+### See Also
+
+- [MDC Array][]
+
+
+
+Array Method: rgbToHsb {#Array:rgbToHsb}
+----------------------------------------
+
+Converts a RGB array to an HSB array.
+
+### Syntax
+
+	var myHSB = myRGBArray.rgbToHsb();
+
+### Returns
+
+* (*array*) An array with HSB values.
+
+### Example
+
+	var myHSB = [255, 0, 0].rgbToHsb(); //Returns [0, 100, 100].
+
+
+
+Array Method: hsbToRgb {#Array:hsbToRgb}
+----------------------------------------
+
+Converts an HSB array to a RGB array.
+
+### Syntax
+
+	var myHSB = myRGBArray.hsbToRgb();
+
+### Returns
+
+* (*array*) An array with RGB values.
+
+### Examples
+
+	var myRGB = [0, 100, 100].hsbToRgb(); //myRGB = [255, 0, 0]
+
+
+
+[Element:setStyle]: /core/Element/Element.Style#Element:setStyles
+[MDC Array]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array

data/Packages/mootools-more/Docs/Utilities/Group.md

@@ -0,0 +1,75 @@
+Class: Group {#Group}
+=====================
+
+This class is for grouping Classes or Events. The Event added to the Group will fire when all of the events of the items of the group are fired.
+
+Group Method: constructor
+-------------------------
+
+### Syntax
+
+	var myGroup = new Group(class[, arrays[, class2[, ... ]]]);
+
+### Arguments
+
+Any number of Class instances, or arrays containing class instances.
+
+### Returns
+
+* (*object*) A new Group instance.
+
+### Examples
+
+	var xhr1 = new Request({url: 'data.js', evalScripts: true});
+	var xhr2 = new Request({url: 'abstraction.js', evalScripts: true});
+	var xhr3 = new Request({url: 'template.js', evalScripts: true});
+
+	var group = new Group(xhr1, xhr2, xhr3);
+	group.addEvent('complete', function(){
+		alert('All Scripts loaded');
+	});
+
+	xhr1.send();
+	xhr2.send();
+	xhr3.send();
+
+
+
+Group Method: addEvent {#Group:addEvent}
+----------------------------------------
+
+Adds an Event to the stack of Events of the Class instances.
+
+### Syntax
+
+	myGroup.addEvent(type, fn);
+
+### Arguments
+
+1. type - (*string*) The event name (e.g. 'complete') to add.
+2. fn   - (*function*) The callback function to execute when all instances fired this event.
+
+### Returns
+
+* (*object*) This Group instance.
+
+### Examples
+
+	var myElements = $('myForm').getElements('input, textarea, select');
+	myElements.addEvent('click', function(){
+		alert('an individual click');
+	});
+
+	var myGroup = new Group(myElements);
+	myGroup.addEvent('click', function(){
+		alert('all form elements clicked');
+	});
+
+
+
+### See Also
+
+* [Element.addEvent][]
+
+
+[Element.addEvent]: /core/Element/Element.Event#Element:addEvent

data/Packages/mootools-more/Docs/Utilities/Hash.Cookie.md

@@ -0,0 +1,117 @@
+Class: Hash.Cookie {#Hash-Cookie}
+=================================
+
+Stores and loads a Hash as a Cookie using JSON format.
+
+### Extends
+
+- [Hash][]
+
+Hash.Cookie Method: constructor
+-------------------------------
+
+### Syntax
+
+	var myHashCookie = new Hash.Cookie(name[, options]);
+
+### Arguments
+
+1. name    - (*string*) The key (name) for the cookie
+2. options - (*object*) All of [Cookie][] options in addition an autoSave option.
+
+#### Options
+
+1. autoSave - (*boolean*: defaults to true) An option to save the cookie at every operation.
+
+### Returns
+
+* (*object*) A new Hash.Cookie instance.
+
+### Examples
+
+	var fruits = new Hash.Cookie('myCookieName', {duration: 3600});
+	fruits.extend({
+		'lemon': 'yellow',
+		'apple': 'red'
+	});
+	fruits.set('melon', 'green');
+	fruits.get('lemon'); // yellow
+
+	// ... on another page ... values load automatically
+
+	var fruits = new Hash.Cookie('myCookieName', {duration: 365});
+	fruits.get('melon'); // green
+
+	fruits.erase(); // delete cookie
+
+### Notes
+
+- All Hash methods are available in your Hash.Cookie instance. if autoSave options is set, every method call will result in your Cookie being saved.
+- Cookies have a limit of 4kb (4096 bytes). Therefore, be careful with your Hash size.
+- All Hash methods used on Hash.Cookie return the return value of the Hash method, unless you exceeded the Cookie size limit. In that case the result will be false.
+- If you plan to use large Cookies consider turning autoSave to off, and check the status of .save() everytime.
+- Creating a new instance automatically loads the data from the Cookie into the Hash. Cool Huh?
+
+### See Also
+
+- [Hash][]
+
+
+
+Hash.Cookie Method: save {#Hash-Cookie:save}
+--------------------------------------------
+
+Saves the Hash to the cookie. If the hash is empty, removes the cookie.
+
+### Syntax
+
+	myHashCookie.save();
+
+### Returns
+
+* (*boolean*) Returns false when the JSON string cookie is too long (4kb), otherwise true.
+
+### Examples
+
+	var login = new Hash.Cookie('userstatus', {autoSave: false});
+
+	login.extend({
+		'username': 'John',
+		'credentials': [4, 7, 9]
+	});
+	login.set('last_message', 'User logged in!');
+
+	login.save(); // finally save the Hash
+
+
+
+Hash.Cookie Method: load {#Hash-Cookie:load}
+--------------------------------------------
+
+Loads the cookie and assigns it to the Hash.
+
+### Syntax
+
+	myHashCookie.load();
+
+### Returns
+
+* (*object*) This Hash.Cookie instance.
+
+### Examples
+
+	var myHashCookie = new Hash.Cookie('myCookie');
+
+	(function(){
+		myHashCookie.load();
+		if (!myHashCookie.getLength()) alert('Cookie Monster must of eaten it!');
+	}).periodical(5000);
+
+### Notes
+
+- Useful when polling.
+
+
+
+[Hash]: /more/Types/Hash/#Hash
+[Cookie]: /core/Utilities/Cookie