Learn from Saki

Knowledge is power

This content is for registered users only. Please login.
Hello! To access your account, please Log in. Not a member? Sign up
  • Videos
  • Blog
  • Examples
  • Services
  • Add-ons
  • About

Writing a Big Application in Ext (Part 3)

March 14, 2009 by saki 15 Comments

Code in this post can be obsolete, however, principles and theory may still apply.

Important

If you have not already done so, study Writing a Big Application in Ext (Part 1) and Writing a Big Application in Ext (Part 2)before you read this article. It would be very hard, if not impossible, to understand concepts explained here before you fully understand the first and second part.

Introduction

Helping on the forum and reading code of others that failed to extend Ext classes, revealed more errors that users, especially beginners, commonly make. Therefore, I’ve decided to start this article that will collect these errors and will explain why the errors are errors. I mean it as loosely ended as I may discover more errors and ways of avoiding them so I plan just to add them to this article, not endlessly create parts 4, 5, etc…

… continued: Most Common Sources of Troubles

Here we go:
  1. Unnecessary Extending
  2. Adding Objects to Prototype
  3. Hard Coding ids
 

Unnecessary Extending

The main reasons for extending are:
  • re-usability
  • adding functionality
  • combination of them
so we extend if we need a re-usable component or we need to add a functionality (new methods) or both. If we are after re-usability the extension can be as simple as:
1
2
3
4
5
MyPortlet = Ext.extend(Ext.Panel, {
     anchor:'100%'
    ,draggable:true
    ,defaultType:'mygraph'
});
You see what happens? We are going to use MyPortlet many times so instead of scatter the above configuration in 10,000 lines application code 100 times, we create this simple extension and we save 297 lines of code. The other aspect is that if we upgrade our ‘mygraph’ to ‘mygraph_new’ the only place where to change it is our extension saving us searching out code for all occurrences of ‘mygraph’ (100 times) and replacing it with ‘mygraph_new’ 100 times. (Well, 100 is exaggerated, but you get the point, right?) If we are after adding functionality, which can be also simple, we add some “logic”:
1
2
3
4
5
6
MyPanel = Ext.extend(Ext.Panel, {
    onRender:function() {
        MyPanel.superclass.onRender.apply(this, arguments);
        alert('Rendered');
    }
});
Here we add some logic to Panel, it does more that it did before. There is no need to extend in all other cases.  

Adding Objects to Prototype

Run this code first:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Extending Error: Object in prototype
 
  Ext.BLANK_IMAGE_URL = 'ext/resources/images/default/s.gif';
  Ext.onReady(function() {
    MyPanel = Ext.extend(Ext.Panel, {
         layout:'fit'
        ,panelConfig: {
            bodyBg:'red'
        }
 
        ,initComponent:function() {
            var config = {
                bodyStyle:'background-color:' + this.panelConfig.bodyBg
            }; // eo config object
 
            // apply config
            Ext.apply(this, Ext.apply(this.initialConfig, config));
 
            MyPanel.superclass.initComponent.apply(this, arguments);
        } // eo function initComponent
 
        ,applyBackground:function(color) {
            this.panelConfig.bodyBg = color;
            this.body.applyStyles({'background-color':color});
        } // eo function applyBackground
 
    }); // eo extend
 
    var p1 = new MyPanel({
         title:'Panel with Blue Background'
        ,renderTo:Ext.getBody()
        ,width:240
        ,height:160
    });
 
    p1.applyBackground('blue');
 
    var p2 = new MyPanel({
         title:'Panel with Red Background'
        ,renderTo:Ext.getBody()
        ,width:240
        ,height:160
    });
 
  });
What do we expect? It is written in titles of panels: Top panel (p1) should have blue body background because we set it to it after it is created. And bottom panel (p2) should have red because we just create default MyPanel. But it is blue too!!! Why? The reason is simple: panelConfig is object that is created during class definition and it is added to MyPanel prototype. Objects (arrays too) are accessed by reference so p1 and p2 share the same instance of panelConfig. Setting bodyBg property in applyBackground method changes this single instance of panelConfig object. So we create p2 with blue background too. You see, here it is clearly and immediately visible that something went wrong but making this error can lead to weeks of wasted debugging time in real applications. Imagine you have a store in prototype…  

Hard Coding ids

Very simple, but deadly mistake is to set ids in the extension either to the main extension object or on its items, toolbars, buttons, etc. If a hard coded ids are set we cannot create two or more instances of our extension, can we?

Loose End

That’s all for now but if I discover more errors I will add them above. Stay tuned! Do not forget to read Part 1 and Part 2 of this article. Follow up: Factory Functions in Ext Extensions (Abstract Classes)
  • Author
  • Recent Posts
Follow me:
saki
I'm a well seasoned developer, consultant and educator of web applications based mainly on Sencha libraries, PHP, MySQL and Node.js. Besides (Apple) computers, I love photography and mountain biking.
Follow me:
Latest posts by saki (see all)
  • Ext, Angular, React, and Vue - June 27, 2019
  • The Site Resurgence - February 11, 2018
  • Configuring ViewModel Hierarchy - June 19, 2015

Filed Under: Know-how Tagged With: extension, extjs, Know-how

Comments

  1. manduks says

    March 19, 2009 at 7:25 am

    hi saki, very good info you have here, i been using your model for extending, i had a problem with ids on a extension of a formpanel when i used vtypes on some fields that this panel had i was trying to validate a password verification, what i did to solve it was asign the ids dinamicly when the panel was created i don´t know if it was correct but it work, maybe you can do something similar to share.
    Another thing that I been dealing a lot is the scope on the extension maybe you can talk i little about this. thanks a lot for such good information, 🙂

    Log in to Reply
  2. Saki says

    March 19, 2009 at 12:54 pm

    Assigning dynamic id is fine as long as you can ensure they are unique on the html page.

    What scope issues do you have in mind?

    Log in to Reply
  3. Jason Boxman says

    April 3, 2009 at 7:46 pm

    Excellent post. Your examples and extensions are always top notch. Thanks!

    Log in to Reply
  4. Saki says

    April 4, 2009 at 2:58 am

    You’re welcome; I’m glad they help.

    Log in to Reply
  5. Charles Ginzel says

    April 5, 2009 at 5:34 pm

    Saki,

    First thanks for all of your efforts and patience to educate all of us. One point I’m confused on here is that in part 1 you advocate creating extensions for each application component but in part 3 you are tackling “over use of extensions”. Maybe I’m missing the point, but if I’m creating non-reusable, but self contained modular components within my application like a specific implementation of a grid or a tree, should I not be creating that as an extension as I thought your were saying in part 1?

    Log in to Reply
  6. Saki says

    April 6, 2009 at 12:31 am

    Maybe it’s not formulated exactly but if you do not plan to reuse a component you do not need to extend. However, if it better suits to your app, programming practices, file organization, etc, you can extend if you want if you do it properly and w/o mistakes.

    Log in to Reply
  7. arno.nyhm says

    April 7, 2009 at 11:34 am

    the red/blue issue: i miss an example how to save the color not in a single instance variable!?

    Log in to Reply
  8. Saki says

    April 7, 2009 at 12:04 pm

    If you move panelConfig to initComponent then it is not in prototype and it will work.

    Log in to Reply
  9. Ash says

    April 9, 2009 at 7:37 pm

    Hi,Thanks for the article.I appreciate your help always.
    I have 20-25 grids in my app.all with different fields in store and different column headers in column model and also different context menus.I am using EditorGridPanel for some and just GridPanel for others.
    Do you think extension of grid panel is needed here ,can it help in avoiding to write 25 column models and store.and provide a generic way to enter store and context menus and column headers?

    Log in to Reply
  10. Saki says

    April 10, 2009 at 3:18 am

    Post please your question to forum and PM me the link to it. I guess many others can face the same problem so better would be to answer there.

    Log in to Reply
  11. Jon says

    August 18, 2009 at 4:44 pm

    I’m curious, why is initComponent not documented in the Ext API reference? It seems like it appears in quite a few examples but isn’t officially a public API.

    Log in to Reply
  12. Yura says

    November 25, 2009 at 1:50 am

    Hi. Thank you for your articles.
    Can you tell how to destroy ext components correctly? I have faced with a lot of memory leaks.

    Thanks.

    P.S. Sorry for my English.

    Log in to Reply
  13. Jaya says

    September 15, 2010 at 9:57 am

    Hi Saki,
    Thanks for sharing the nice techniques on ExtJS. I have just started working on this nice framework. I am trying to use it in my new application, which has lot of main and sub modules. When I am surfing for some design concepts I came across think link: http://www.sencha.com/forum/archive/index.php/t-71873.html

    Where you mentioned that,

    Log in to Reply
  14. Jaya says

    September 15, 2010 at 10:02 am

    Hi Saki,
    Thanks for sharing the nice techniques on ExtJS. As part of my new App design concepts I came across the link: http://www.sencha.com/forum/archive/index.php/t-71873.html
    Where you mentioned that ‘Have you seen my examples? They’re tree on the left and ifram in the center.’
    If possible, can you please share/point me to sample code to implement the same.

    Log in to Reply
  15. Saki says

    September 16, 2010 at 4:02 am

    Just dig into http://examples.learnfromsaki.com

    Log in to Reply

We will be happy to hear back from you Cancel reply

You must be logged in to post a comment.

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Categories

  • Addons (2)
  • Architecture (14)
  • Examples (2)
  • ExtJS (26)
  • Howtos (16)
  • Javascript (1)
  • Know-how (32)
  • Linux (1)
  • Mac OS X (2)
  • SASS/CSS (2)
  • Snippets (9)
  • Theory (14)
  • Touch (6)
  • Tutorials (5)
  • What is a … (9)

Tag cloud

abstract class accordion application button class cluster column component config css definition deprecated design education event example extension extjs factory function form grid html initComponent items javascript Know-how knowledge layout Linux listener mysql old panel pattern php plugin render snippet sql sqlite state table touch tree viewpoint

Membership

Become a Member
Affiliate Program

Support

FAQ
Contact

Legal

Terms and Conditions
Licensing
Privacy Policy

Copyright © 2021 · Dynamik-Gen on Genesis Framework · WordPress · Log in