ExtJs的api文檔該怎么看

寫在前面

之前有在ExtJS初體驗(yàn)中說了ExtJs給我們項(xiàng)目開發(fā)帶來了很多便利机打,有童鞋在下面留言問extjs的API該怎么看逸雹?很多剛?cè)腴T的童鞋被ExtJs里各種龐大的控件弄暈了豺旬,不知道怎么看api。那么這篇我就簡(jiǎn)單地說下extjs的api該怎么看忘古。

ExtJs的api文檔該怎么看

如果想在本地查看extjs的api振湾,大家自行下載解壓查看即可硝训,查看方法網(wǎng)上很多科平,不再贅述锨匆。這里我們直接看extjs的在線官方文檔:Ext JS 6.0.0 - Modern Toolkit ,界面如下:

API中私痹,都是針對(duì)每個(gè)類來講解的,每個(gè)類中又基本上都由以下4部分組成:

Config Options , 配置項(xiàng)
Public Properties, 公共屬性
Public Methods, 公共方法
Public Events, 公共事件

1.Config Options
Config Options下的內(nèi)容為你在實(shí)例化一個(gè)對(duì)象時(shí)進(jìn)行配置的, 這個(gè)所謂的配置選項(xiàng)统刮,也就是Config Options下的內(nèi)容紊遵,只有你在實(shí)例化的時(shí)候用的,也就是你在new 類名({…})時(shí)用的侥蒙。下面以Panel類寫個(gè)例子說明:

var subsys_grid = Ext.create('Ext.grid.Panel', {
        title:'子系統(tǒng)列表',
        region:'west',
        width:300,
        columnLines : true,
        striped : true,
        store : subsys_store,
        selModel:sub_selModel,
        columns : [ {
            xtype : 'rownumberer'
        }, {
            text : '編號(hào)',
            dataIndex : '編號(hào)',
            sortable:false,
            hideable : false,
            flex : 1
        }, {
            text : '名稱',
            dataIndex : '名稱',
            sortable:false,
            hideable : false,
            flex : 1
        }, {
            text : '描述',
            dataIndex : '描述',
            sortable:false,
            hideable : false,
            flex : 1
        }]
            });

Ext.create方法中傳入了兩個(gè)參數(shù)暗膜,第一個(gè)是控件的類名或別名,第二個(gè)參數(shù)就是該控件的配置項(xiàng)了鞭衩。

我們?cè)谂渲庙?xiàng)中找到了region和width学搜,試試對(duì)Panel的作用。將此兩項(xiàng)改成如下:

region:'east',
width:500,

運(yùn)行后论衍,會(huì)明顯的發(fā)現(xiàn)標(biāo)題叫"子系統(tǒng)列表'"的Panel的位置和寬度發(fā)生明顯的變化瑞佩。

2.Public Properties
Public Properties定義了對(duì)象的成員變量,表示的是你從一個(gè)實(shí)例化對(duì)象里取得的屬性坯台【嫱瑁可以直接通過點(diǎn)號(hào)來訪問的,通常該部分都是只讀的屬性蜒蕾。比如上面的例子實(shí)例化了一個(gè)對(duì)象subsys_grid 稠炬,那么現(xiàn)在你可以取實(shí)例化對(duì)象的數(shù)據(jù)了。比如:subsys_grid.title就能取得Panel的標(biāo)題咪啡。該部分沒什么好說的首启,對(duì)照著看說明就是了

3.Public Methods
該部分定義了對(duì)象的能夠被訪問的公開方法。

比如add方法撤摸,**add ( newItems ) : Ext.Component / Ext.Component[] **,它的參數(shù)及返回值說明如下:

由上圖可以看出毅桃,add方法可以接受一個(gè)對(duì)象/對(duì)象數(shù)組/組件/組件數(shù)組的參數(shù),返回的可以是組件或者組件數(shù)組准夷。

我們展開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

該例子表示的是將一個(gè)或多個(gè)組件添加到該容器中钥飞。

4.Public Events


這里以activate ( newActiveItem , this , oldActiveItem , eOpts ) 方法為例,在這個(gè)對(duì)象的listeners里冕象,你可以監(jiān)聽active這個(gè)方法代承,這個(gè)方法有四個(gè)參數(shù)汁蝶,注意::第二個(gè)參數(shù)Ext.Container this渐扮,不要在使用時(shí)论悴,也命名變量叫this,因?yàn)樗莏avascript的關(guān)鍵字墓律。

該事件的發(fā)生條件:Fires whenever item within the Container is activated.
直譯為:每當(dāng)容器內(nèi)的對(duì)象被激活時(shí)膀估,將觸發(fā)改事件。

ExtJs的事件監(jiān)聽耻讽,除了直接在對(duì)象創(chuàng)建時(shí)指定listeners外察纯,還可以在對(duì)象創(chuàng)建后用on方法來實(shí)現(xiàn)動(dòng)態(tài)的添加。例如:

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.編號(hào);
            var name = selected[0].data.名稱;
            subCode_v = code;
            todo_store.proxy.extraParams={sub_sys:code}
            todo_store.load();
            
        }
    });

寫在最后

對(duì)于ExtJs的api文檔针肥,只要有點(diǎn)英文基礎(chǔ)饼记,掌握基本的用法,平時(shí)多加應(yīng)用慰枕,Extjs終會(huì)成為你的一本快速開發(fā)的武林秘籍 具则。

了解更多:
Sencha中文站

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市具帮,隨后出現(xiàn)的幾起案子博肋,更是在濱河造成了極大的恐慌,老刑警劉巖蜂厅,帶你破解...
    沈念sama閱讀 217,542評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件匪凡,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡掘猿,警方通過查閱死者的電腦和手機(jī)病游,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來稠通,“玉大人礁遵,你說我怎么就攤上這事〔杉牵” “怎么了佣耐?”我有些...
    開封第一講書人閱讀 163,912評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)唧龄。 經(jīng)常有香客問我兼砖,道長(zhǎng),這世上最難降的妖魔是什么既棺? 我笑而不...
    開封第一講書人閱讀 58,449評(píng)論 1 293
  • 正文 為了忘掉前任讽挟,我火速辦了婚禮,結(jié)果婚禮上丸冕,老公的妹妹穿的比我還像新娘耽梅。我一直安慰自己,他們只是感情好胖烛,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評(píng)論 6 392
  • 文/花漫 我一把揭開白布眼姐。 她就那樣靜靜地躺著诅迷,像睡著了一般。 火紅的嫁衣襯著肌膚如雪众旗。 梳的紋絲不亂的頭發(fā)上罢杉,一...
    開封第一講書人閱讀 51,370評(píng)論 1 302
  • 那天,我揣著相機(jī)與錄音贡歧,去河邊找鬼滩租。 笑死,一個(gè)胖子當(dāng)著我的面吹牛利朵,可吹牛的內(nèi)容都是我干的律想。 我是一名探鬼主播,決...
    沈念sama閱讀 40,193評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼绍弟,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼蜘欲!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起晌柬,我...
    開封第一講書人閱讀 39,074評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤姥份,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后年碘,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體澈歉,經(jīng)...
    沈念sama閱讀 45,505評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評(píng)論 3 335
  • 正文 我和宋清朗相戀三年屿衅,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了埃难。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,841評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡涤久,死狀恐怖涡尘,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情响迂,我是刑警寧澤考抄,帶...
    沈念sama閱讀 35,569評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站蔗彤,受9級(jí)特大地震影響川梅,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜然遏,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評(píng)論 3 328
  • 文/蒙蒙 一贫途、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧待侵,春花似錦丢早、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)傀缩。三九已至,卻和暖如春凫碌,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背胃榕。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工盛险, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人勋又。 一個(gè)月前我還...
    沈念sama閱讀 47,962評(píng)論 2 370
  • 正文 我出身青樓苦掘,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親楔壤。 傳聞我的和親對(duì)象是個(gè)殘疾皇子鹤啡,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)蹲嚣,斷路器递瑰,智...
    卡卡羅2017閱讀 134,656評(píng)論 18 139
  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序:基本語(yǔ)法,類相關(guān)的語(yǔ)法隙畜,內(nèi)部類的語(yǔ)法抖部,繼承相關(guān)的語(yǔ)法,異常的語(yǔ)法议惰,線程的語(yǔ)...
    子非魚_t_閱讀 31,631評(píng)論 18 399
  • 面向?qū)ο笾饕槍?duì)面向過程慎颗。 面向過程的基本單元是函數(shù)。 什么是對(duì)象:EVERYTHING IS OBJECT(萬(wàn)物...
    sinpi閱讀 1,054評(píng)論 0 4
  • 1.import static是Java 5增加的功能,就是將Import類中的靜態(tài)方法言询,可以作為本類的靜態(tài)方法來...
    XLsn0w閱讀 1,222評(píng)論 0 2
  • 閉上眼使勁想都想不起來那一天之前的事情俯萎。暫且把那天當(dāng)做記憶的起點(diǎn)。 我出生在一個(gè)東北小村落运杭,一家5口住在一個(gè)溫...
    卡斯洛賓閱讀 192評(píng)論 0 0