4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
13 * @class Roo.Component
14 * @extends Roo.util.Observable
15 * Base class for all major Roo components. All subclasses of Component can automatically participate in the standard
16 * Roo component lifecycle of creation, rendering and destruction. They also have automatic support for basic hide/show
17 * and enable/disable behavior. Component allows any subclass to be lazy-rendered into any {@link Roo.Container} and
18 * to be automatically registered with the {@link Roo.ComponentMgr} so that it can be referenced at any time via {@link Roo.getCmp}.
19 * All visual components (widgets) that require rendering into a layout should subclass Component.
21 * @param {Roo.Element/String/Object} config The configuration options. If an element is passed, it is set as the internal
22 * element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element
23 * and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.
25 Roo.Component = function(config){
26 config = config || {};
27 if(config.tagName || config.dom || typeof config == "string"){ // element object
28 config = {el: config, id: config.id || config};
30 this.initialConfig = config;
32 Roo.apply(this, config);
36 * Fires after the component is disabled.
37 * @param {Roo.Component} this
42 * Fires after the component is enabled.
43 * @param {Roo.Component} this
48 * Fires before the component is shown. Return false to stop the show.
49 * @param {Roo.Component} this
54 * Fires after the component is shown.
55 * @param {Roo.Component} this
60 * Fires before the component is hidden. Return false to stop the hide.
61 * @param {Roo.Component} this
66 * Fires after the component is hidden.
67 * @param {Roo.Component} this
72 * Fires before the component is rendered. Return false to stop the render.
73 * @param {Roo.Component} this
78 * Fires after the component is rendered.
79 * @param {Roo.Component} this
83 * @event beforedestroy
84 * Fires before the component is destroyed. Return false to stop the destroy.
85 * @param {Roo.Component} this
90 * Fires after the component is destroyed.
91 * @param {Roo.Component} this
96 this.id = "ext-comp-" + (++Roo.Component.AUTO_ID);
98 Roo.ComponentMgr.register(this);
99 Roo.Component.superclass.constructor.call(this);
100 this.initComponent();
101 if(this.renderTo){ // not supported by all components yet. use at your own risk!
102 this.render(this.renderTo);
103 delete this.renderTo;
108 Roo.Component.AUTO_ID = 1000;
110 Roo.extend(Roo.Component, Roo.util.Observable, {
112 * @scope Roo.Component.prototype
114 * true if this component is hidden. Read-only.
119 * true if this component is disabled. Read-only.
124 * true if this component has been rendered. Read-only.
128 /** @cfg {String} disableClass
129 * CSS class added to the component when it is disabled (defaults to "x-item-disabled").
131 disabledClass : "x-item-disabled",
132 /** @cfg {Boolean} allowDomMove
133 * Whether the component can move the Dom node when rendering (defaults to true).
136 /** @cfg {String} hideMode
137 * How this component should hidden. Supported values are
138 * "visibility" (css visibility), "offsets" (negative offset position) and
139 * "display" (css display) - defaults to "display".
144 ctype : "Roo.Component",
147 * @cfg {String} actionMode
148 * which property holds the element that used for hide() / show() / disable() / enable()
154 getActionEl : function(){
155 return this[this.actionMode];
158 initComponent : Roo.emptyFn,
160 * If this is a lazy rendering component, render it to its container element.
161 * @param {String/HTMLElement/Element} container (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.
163 render : function(container, position){
164 if(!this.rendered && this.fireEvent("beforerender", this) !== false){
165 if(!container && this.el){
166 this.el = Roo.get(this.el);
167 container = this.el.dom.parentNode;
168 this.allowDomMove = false;
170 this.container = Roo.get(container);
171 this.rendered = true;
172 if(position !== undefined){
173 if(typeof position == 'number'){
174 position = this.container.dom.childNodes[position];
176 position = Roo.getDom(position);
179 this.onRender(this.container, position || null);
181 this.el.addClass(this.cls);
185 this.el.applyStyles(this.style);
188 this.fireEvent("render", this);
189 this.afterRender(this.container);
201 // default function is not really useful
202 onRender : function(ct, position){
204 this.el = Roo.get(this.el);
205 if(this.allowDomMove !== false){
206 ct.dom.insertBefore(this.el.dom, position);
212 getAutoCreate : function(){
213 var cfg = typeof this.autoCreate == "object" ?
214 this.autoCreate : Roo.apply({}, this.defaultAutoCreate);
215 if(this.id && !cfg.id){
222 afterRender : Roo.emptyFn,
225 * Destroys this component by purging any event listeners, removing the component's element from the DOM,
226 * removing the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.
228 destroy : function(){
229 if(this.fireEvent("beforedestroy", this) !== false){
230 this.purgeListeners();
231 this.beforeDestroy();
233 this.el.removeAllListeners();
235 if(this.actionMode == "container"){
236 this.container.remove();
240 Roo.ComponentMgr.unregister(this);
241 this.fireEvent("destroy", this);
246 beforeDestroy : function(){
251 onDestroy : function(){
256 * Returns the underlying {@link Roo.Element}.
257 * @return {Roo.Element} The element
264 * Returns the id of this component.
272 * Try to focus this component.
273 * @param {Boolean} selectText True to also select the text in this component (if applicable)
274 * @return {Roo.Component} this
276 focus : function(selectText){
279 if(selectText === true){
280 this.el.dom.select();
295 * Disable this component.
296 * @return {Roo.Component} this
298 disable : function(){
302 this.disabled = true;
303 this.fireEvent("disable", this);
308 onDisable : function(){
309 this.getActionEl().addClass(this.disabledClass);
310 this.el.dom.disabled = true;
314 * Enable this component.
315 * @return {Roo.Component} this
321 this.disabled = false;
322 this.fireEvent("enable", this);
327 onEnable : function(){
328 this.getActionEl().removeClass(this.disabledClass);
329 this.el.dom.disabled = false;
333 * Convenience function for setting disabled/enabled by boolean.
334 * @param {Boolean} disabled
336 setDisabled : function(disabled){
337 this[disabled ? "disable" : "enable"]();
341 * Show this component.
342 * @return {Roo.Component} this
345 if(this.fireEvent("beforeshow", this) !== false){
350 this.fireEvent("show", this);
357 var ae = this.getActionEl();
358 if(this.hideMode == 'visibility'){
359 ae.dom.style.visibility = "visible";
360 }else if(this.hideMode == 'offsets'){
361 ae.removeClass('x-hidden');
363 ae.dom.style.display = "";
368 * Hide this component.
369 * @return {Roo.Component} this
372 if(this.fireEvent("beforehide", this) !== false){
377 this.fireEvent("hide", this);
384 var ae = this.getActionEl();
385 if(this.hideMode == 'visibility'){
386 ae.dom.style.visibility = "hidden";
387 }else if(this.hideMode == 'offsets'){
388 ae.addClass('x-hidden');
390 ae.dom.style.display = "none";
395 * Convenience function to hide or show this component by boolean.
396 * @param {Boolean} visible True to show, false to hide
397 * @return {Roo.Component} this
399 setVisible: function(visible){
409 * Returns true if this component is visible.
411 isVisible : function(){
412 return this.getActionEl().isVisible();
415 cloneConfig : function(overrides){
416 overrides = overrides || {};
417 var id = overrides.id || Roo.id();
418 var cfg = Roo.applyIf(overrides, this.initialConfig);
419 cfg.id = id; // prevent dup id
420 return new this.constructor(cfg);