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 * Ext 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 * @property {Boolean} hidden
113 * true if this component is hidden. Read-only.
117 * true if this component is disabled. Read-only.
121 * true if this component has been rendered. Read-only.
125 /** @cfg {String} disableClass
126 * CSS class added to the component when it is disabled (defaults to "x-item-disabled").
128 disabledClass : "x-item-disabled",
129 /** @cfg {Boolean} allowDomMove
130 * Whether the component can move the Dom node when rendering (defaults to true).
133 /** @cfg {String} hideMode
134 * How this component should hidden. Supported values are
135 * "visibility" (css visibility), "offsets" (negative offset position) and
136 * "display" (css display) - defaults to "display".
141 ctype : "Roo.Component",
143 /** @cfg {String} actionMode
144 * which property holds the element that used for hide() / show() / disable() / enable()
150 getActionEl : function(){
151 return this[this.actionMode];
154 initComponent : Roo.emptyFn,
156 * If this is a lazy rendering component, render it to its container element.
157 * @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.
159 render : function(container, position){
160 if(!this.rendered && this.fireEvent("beforerender", this) !== false){
161 if(!container && this.el){
162 this.el = Roo.get(this.el);
163 container = this.el.dom.parentNode;
164 this.allowDomMove = false;
166 this.container = Roo.get(container);
167 this.rendered = true;
168 if(position !== undefined){
169 if(typeof position == 'number'){
170 position = this.container.dom.childNodes[position];
172 position = Roo.getDom(position);
175 this.onRender(this.container, position || null);
177 this.el.addClass(this.cls);
181 this.el.applyStyles(this.style);
184 this.fireEvent("render", this);
185 this.afterRender(this.container);
197 // default function is not really useful
198 onRender : function(ct, position){
200 this.el = Roo.get(this.el);
201 if(this.allowDomMove !== false){
202 ct.dom.insertBefore(this.el.dom, position);
208 getAutoCreate : function(){
209 var cfg = typeof this.autoCreate == "object" ?
210 this.autoCreate : Roo.apply({}, this.defaultAutoCreate);
211 if(this.id && !cfg.id){
218 afterRender : Roo.emptyFn,
221 * Destroys this component by purging any event listeners, removing the component's element from the DOM,
222 * removing the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.
224 destroy : function(){
225 if(this.fireEvent("beforedestroy", this) !== false){
226 this.purgeListeners();
227 this.beforeDestroy();
229 this.el.removeAllListeners();
231 if(this.actionMode == "container"){
232 this.container.remove();
236 Roo.ComponentMgr.unregister(this);
237 this.fireEvent("destroy", this);
242 beforeDestroy : function(){
247 onDestroy : function(){
252 * Returns the underlying {@link Roo.Element}.
253 * @return {Roo.Element} The element
260 * Returns the id of this component.
268 * Try to focus this component.
269 * @param {Boolean} selectText True to also select the text in this component (if applicable)
270 * @return {Roo.Component} this
272 focus : function(selectText){
275 if(selectText === true){
276 this.el.dom.select();
291 * Disable this component.
292 * @return {Roo.Component} this
294 disable : function(){
298 this.disabled = true;
299 this.fireEvent("disable", this);
304 onDisable : function(){
305 this.getActionEl().addClass(this.disabledClass);
306 this.el.dom.disabled = true;
310 * Enable this component.
311 * @return {Roo.Component} this
317 this.disabled = false;
318 this.fireEvent("enable", this);
323 onEnable : function(){
324 this.getActionEl().removeClass(this.disabledClass);
325 this.el.dom.disabled = false;
329 * Convenience function for setting disabled/enabled by boolean.
330 * @param {Boolean} disabled
332 setDisabled : function(disabled){
333 this[disabled ? "disable" : "enable"]();
337 * Show this component.
338 * @return {Roo.Component} this
341 if(this.fireEvent("beforeshow", this) !== false){
346 this.fireEvent("show", this);
353 var ae = this.getActionEl();
354 if(this.hideMode == 'visibility'){
355 ae.dom.style.visibility = "visible";
356 }else if(this.hideMode == 'offsets'){
357 ae.removeClass('x-hidden');
359 ae.dom.style.display = "";
364 * Hide this component.
365 * @return {Roo.Component} this
368 if(this.fireEvent("beforehide", this) !== false){
373 this.fireEvent("hide", this);
380 var ae = this.getActionEl();
381 if(this.hideMode == 'visibility'){
382 ae.dom.style.visibility = "hidden";
383 }else if(this.hideMode == 'offsets'){
384 ae.addClass('x-hidden');
386 ae.dom.style.display = "none";
391 * Convenience function to hide or show this component by boolean.
392 * @param {Boolean} visible True to show, false to hide
393 * @return {Roo.Component} this
395 setVisible: function(visible){
405 * Returns true if this component is visible.
407 isVisible : function(){
408 return this.getActionEl().isVisible();
411 cloneConfig : function(overrides){
412 overrides = overrides || {};
413 var id = overrides.id || Roo.id();
414 var cfg = Roo.applyIf(overrides, this.initialConfig);
415 cfg.id = id; // prevent dup id
416 return new this.constructor(cfg);