ExtJs的api文档该怎么看

写在前面

之前有在ExtJS初体验中说了ExtJs给我们项目开发带来了很多便利,有童鞋在下面留言问extjs的API该怎么看?很多刚入门的童鞋被ExtJs里各种庞大的控件弄晕了,不知道怎么看api。那么这篇我就简单地说下extjs的api该怎么看。

ExtJs的api文档该怎么看

如果想在本地查看extjs的api,大家自行下载解压查看即可,查看方法网上很多,不再赘述。这里我们直接看extjs的在线官方文档:Ext JS 6.0.0 - Modern Toolkit ,界面如下:

API中,都是针对每个类来讲解的,每个类中又基本上都由以下4部分组成:

Config Options , 配置项
Public Properties, 公共属性
Public Methods, 公共方法
Public Events, 公共事件

1.Config Options
Config Options下的内容为你在实例化一个对象时进行配置的, 这个所谓的配置选项,也就是Config Options下的内容,只有你在实例化的时候用的,也就是你在new 类名({…})时用的。下面以Panel类写个例子说明:

var subsys_grid = Ext.create('Ext.grid.Panel', {
        title:'子系统列表',
        region:'west',
        width:300,
        columnLines : true,
        striped : true,
        store : subsys_store,
        selModel:sub_selModel,
        columns : [ {
            xtype : 'rownumberer'
        }, {
            text : '编号',
            dataIndex : '编号',
            sortable:false,
            hideable : false,
            flex : 1
        }, {
            text : '名称',
            dataIndex : '名称',
            sortable:false,
            hideable : false,
            flex : 1
        }, {
            text : '描述',
            dataIndex : '描述',
            sortable:false,
            hideable : false,
            flex : 1
        }]
            });

Ext.create方法中传入了两个参数,第一个是控件的类名或别名,第二个参数就是该控件的配置项了。

我们在配置项中找到了region和width,试试对Panel的作用。将此两项改成如下:

region:'east',
width:500,

运行后,会明显的发现标题叫"子系统列表'"的Panel的位置和宽度发生明显的变化。

2.Public Properties
Public Properties定义了对象的成员变量,表示的是你从一个实例化对象里取得的属性。可以直接通过点号来访问的,通常该部分都是只读的属性。比如上面的例子实例化了一个对象subsys_grid ,那么现在你可以取实例化对象的数据了。比如:subsys_grid.title就能取得Panel的标题。该部分没什么好说的,对照着看说明就是了

3.Public Methods
该部分定义了对象的能够被访问的公开方法。

比如add方法,**add ( newItems ) : Ext.Component / Ext.Component[] **,它的参数及返回值说明如下:

由上图可以看出,add方法可以接受一个对象/对象数组/组件/组件数组的参数,返回的可以是组件或者组件数组。

我们展开add方法有如下example:

var myPanel = Ext.create('Ext.Panel', {
    html: 'This will be added to a Container'
});

var items = myContainer.add([myPanel]); // Array returned
var item = myContainer.add(myPanel); // One item is returned

该例子表示的是将一个或多个组件添加到该容器中。

4.Public Events


这里以activate ( newActiveItem , this , oldActiveItem , eOpts ) 方法为例,在这个对象的listeners里,你可以监听active这个方法,这个方法有四个参数,注意::第二个参数Ext.Container this,不要在使用时,也命名变量叫this,因为它是javascript的关键字。

该事件的发生条件:Fires whenever item within the Container is activated.
直译为:每当容器内的对象被激活时,将触发改事件。

ExtJs的事件监听,除了直接在对象创建时指定listeners外,还可以在对象创建后用on方法来实现动态的添加。例如:

var sub_selModel = Ext.create('Ext.selection.CheckboxModel', {
        mode:'SINGLE'
    });
    var subCode_v = '';
    sub_selModel.on('selectionchange', function(m, selected, eOpts) {
        subCode_v = '';
        if (selected.length > 0) {
            Ext.getCmp('addtodo').setDisabled(false);
            var code = selected[0].data.编号;
            var name = selected[0].data.名称;
            subCode_v = code;
            todo_store.proxy.extraParams={sub_sys:code}
            todo_store.load();
            
        }
    });

写在最后

对于ExtJs的api文档,只要有点英文基础,掌握基本的用法,平时多加应用,Extjs终会成为你的一本快速开发的武林秘籍 。

了解更多:
Sencha中文站

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,581评论 18 399
  • 面向对象主要针对面向过程。 面向过程的基本单元是函数。 什么是对象:EVERYTHING IS OBJECT(万物...
    sinpi阅读 1,045评论 0 4
  • 1.import static是Java 5增加的功能,就是将Import类中的静态方法,可以作为本类的静态方法来...
    XLsn0w阅读 1,212评论 0 2
  • 闭上眼使劲想都想不起来那一天之前的事情。暂且把那天当做记忆的起点。 我出生在一个东北小村落,一家5口住在一个温...
    卡斯洛宾阅读 188评论 0 0