Class Index | File Index

Classes


Class RichFaces.BaseComponent

Base class for all components. All RichFaces components should use this class as base or another RichFaces class which based on it.


		//Inheritance example:
		(function ($, richfaces, params) {

			// Constructor definition
			richfaces.MyComponent = function(componentId, [options]) {
				// call constructor of parent class
				$super.constructor.call(this, componentId, [options]);
				
				
				// call this.attachToDom method to attach component to dom element
				// its required for the client side API calls and to clean up after ajax request or page unload:
				// destroy method will be called if component attached to dom
				this.attachToDom(componentId);
				
			};

			// define private method
			var myPrivateMethod = function () {
			}

			// Extend component class and add protected methods from parent class to our container
			richfaces.BaseComponent.extend(richfaces.BaseComponent, richfaces.MyComponent);

			// define super class link
			var $super = richfaces.MyComponent.$super;

			// Add new properties and methods
			$.extend(richfaces.MyComponent.prototype, (function (params) {
				return {
		 				name:"MyComponent",
						f:function (){alert("hello"),
						// destroy method definition for clean up
						destroy: function () {
							// clean up code here
							
							// call parent's destroy method
							$super.destroy.call(this);
						}
					}
				};
			})(params));
		})(jQuery, RichFaces);
		

Defined in: richfaces-base-component.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Class Detail
RichFaces.BaseComponent(componentId)
Parameters:
{String} componentId
- component id

Documentation generated by JsDoc Toolkit 2.0.0 on Wed Jan 05 2011 16:12:54 GMT-0500 (EST)