extjs核心api详解.doc

/j2me/profile1EXT核心API详解(一)-Ext1EXT核心API详解(二)-Array/Date/Function/Number/String5EXT核心API详解(三)-Ext.Element9EXT核心API详解(四)-Ext.DomQuery/DomHelper/Template21EXT核心API详解(五)-24EXT核心API详解(六)-Ext.Fx27EXT核心API详解(七)-30EXT核心API详解Ext.data(八) -Connection/Ajax/Record35EXT核心API详解Ext.data(九)-DataProxy/HttpProxy/MemoryProxy/ScriptTagProxy38EXT核心API详解Ext.data(十)-DataReader/ArrayReader/JsonReader/XmlReader40EXT核心API详解Ext.data(十一)-Store44EXT核心API详解Ext.data(十二)-GroupingStore/JsonStore/SimpleStore49EXT核心API详解Ext.data(十三)-Tree/Node51EXT核心API详解Ext.widgets(十四)-Button,SplitButton,CycleButton54EXT核心API详解Ext.widgets(十五)-form(上)61EXT核心API详解Ext.widgets(十六)-form(下)67EXT核心API详解Ext.menu.Menu(十七)74EXT核心API详解Ext.Toolbar(十八)80EXT核心API详解Ext.widgets(十九)-grid(1)83EXT核心API详解Ext.widgets(二十)-grid(2)89/j2me/profileEXT核心API详解(一)-ExtExt类addBehaviors( Object obj ) : void对选择的元素 应用事件侦听器,事件名以附加在结尾,例如addBehaviors( / id=foo下所有的a标签加入click事件 #foo aclick : function(e, t) / do something , / 用,分隔多个选择器 #foo a, #bar span.some-classmouseover : function() / do something );apply( Object obj, Object config, Object defaults ) : Object从config拷贝所有的属性到obj,如果有defaults参数,也将拷贝其属性到objapplyIf( Object obj, Object config ) : Object从config拷贝所有属性至obj(如果obj未定义相应属性)decode(Object obj) : String编码一个对象/数组或其它值为一个json格式字符串(支持对象,数组,日期,字符串)destroy( Mixed arg1, Mixed (optional), Mixed (optional) ) : void尝试去移除每个传入的对象,包括DOM,事件侦听者,并呼叫他们的destroy方法(如果存在)each( Array/NodeList/Mixed array, Function fn, Object scope ) : void利用array中的每个元素迭代调用fn.直到fn返回假,调用格式fn.call(scope | arrayi, arrayi, i, array);encode(String json) : Object将一个json格式字符串反序列化为对象escapeRe( String str ) : String为字符串正则编码将.在*+?$()|/字符前加extend( Object subclass, Object superclass, Object overrides ) : void从superclass类继承subclass,overrides参数是要重载的方法列表,详见overridefly( String/HTMLElement el, String named ) : Element得到全局共享的一个浮动元素el,如果有多个浮动元素可以使用命名以避免潜在的冲突get( Mixed el ) : Element得到一个Element对象,参数可以是id或DOM节点或已存在的Element对象getBody() : Element得到当前文档的body对象getCmp( String id ) : Component通过id得到一个Component对象getDoc() : Element得到当前文档getDom( Mixed el ) : HTMLElement通过id或节点或Element对象返回一个DOM节点id( Mixed el, String prefix ) : String为对象el生成一个惟一id,如果对象本身已有id,将不会被改变(可以使用前导符prefix)isEmpty( Mixed value, Boolean allowBlank ) : Boolean判断值是否为空,null, undefined或空字符串将返回真,如果allowBlank定义为真,空字符串将不被视为空namespace( String namespace1, String namespace2, String etc ) : void创建一个命名空间,例Espace(Company, Company.data);Company.Widget = function() . Company.data.CustomStore = function(config) . num( Mixed value, Number defaultValue ) : Number将value转为数值,如果value不是合法的数值类型,将返回defaultValue,其实defaultValue并不一定要求是数值类型,只要你愿意onReady( Function fn, Object scope, boolean override ) : void当文档准备好了之后引发fn,发生在page的onload事件之前,并且图片此时都还没有载入,scope定义执有者,override定义scope是否有默认的选择override( Object origclass, Object overrides ) : void利用overrides重写origclass的方法,例Ext.override(MyClass, newMethod1: function() / etc. , newMethod2: function(foo) / etc. );query( String path, Node root ) : Array通过path,在root中选择节点数组,path可以是以下四种选择器之一元素选择器 例:* 任意节点E 一个E标签元素E F 祖先节点为E的F节点E F 或 E/F 父节点为E的F节点E + F 前一个兄弟节点为E的F节点E F 前面的兄弟节点中有E的F节点属性选择器 例:Efoo 有foo属性的E节点Efoo=bar 有foo属性值为bar的E节点Efoo=bar foo属性以bar开始的E节点Efoo$=bar foo属性以bar结尾的E节点Efoo*=bar foo属性中有bar字符串的E节点Efoo%=2 foo属性能被2整除的E节点Efoo!=bar foo属性值不为bar的E节点伪类选择器 例:E:first-child E节点是父节点中第一个子节点E:last-child E节点是父节点中最后一个子节点E:nth-child(n) E是父节点中每n个节点E:nth-child(odd) E是父节点中的奇数节点E:nth-child(even) E是父节点中的偶数节点E:only-child E是父节点中惟一的子节点E:checked checked属性为真的节点E:first 子孙节点中的第一个E节点E:last 子孙节点中的最后一个E节点E:nth(n) 子孙节点中的第n个E节点E:odd E:nth-child(odd)的简写E:even E:nth-child(even)的简写E:contains(foo) innerHTML属性中含有foo的E节点E:nodeValue(foo) E节点中包含一个值为foo的文本节点E:not(S) 不匹配简单选择器S的E节点E:has(S) 有能匹配简单选择器S的子节点的E节点E:next(S) 下一个兄弟节匹配简单选择器S的E节点E:prev(S) 前一个兄弟节匹配简单选择器S的E节点type( Mixed object ) : String判断对象类型,如果不是下列值之一将返回false样式选择器 例:Edisplay=none display属性值为none的E节点Edisplay=none display属性值以none开始的E节点Edisplay$=none display属性值以none结束的E节点Edisplay*=none display属性值含有none子字串的E节点Edisplay%=2 display属性值能被2整除的E节点Edisplay!=none display属性值不等于none的E节点select( String/Array selector, Boolean unique, HTMLElement/String root ) :CompositeElementLite/CompositeElement在root内通过样式选择器或元素数组selector选择元素或元素列表,unique指示是否只选择惟一值urlDecode( String string, Boolean overwrite ) : Object将url格式字符串string解码为json对象,overwrite参数指示是否不重写已存在的对象,例Ext.urlDecode(foo=1&bar=2); /返回 foo: 1, bar: 2 Ext.urlDecode(foo=1&bar=2&bar=3&bar=4); /返回 foo: 1, bar: 4.Ext.urlDecode(foo=1&bar=2&bar=3&bar=4, true); /返回 foo: 1, bar: 2, 3, 4.urlEncode( Object o ) : String将json对象编码为url格式字符串,参见urlDecode type( Mixed object ) : String得到object类型,如果不为以下列举值之一则返回falsestring/number/boolean/function/object/array/regexp/element/nodelist/textnode/whitespaceEXT核心API详解(二)-Array/Date/Function/Number/StringArray类indexOf( Object o ) : Numberobject是否在数组中,找不到返回-1;找到返回位置remove( Object o ) : Array从数组中删除指定的对象object,如果找不到object则数组无变化Number类constrain( Number min, Number max ) : Number检查数值是否介于min与max之间, 如果大于max 返回max,如果小于min返回min, 否则返回当前值String类escape( String string ) : String将string中的和替换为 format( String string, String value1, String value2 ) : String格式化字符串,例:var cls = my-class, text = Some text;var s = String.format(1, cls, text);/ 结果 Some textleftPad( String string, Number size, String char ) : String以char将string补齐为size长度,char默认定义空格toggle( String value, String other ) : String交换值,如果当前值等于value,则被赋值other,反之等于value,例:sort = sort.toggle(ASC, DESC);trim() : String去除开头或结尾多余的空格Date类Date.parseDate( String input, String format ) : Date将字符串string依指定的格式format转换为时间,其中格式定义详见format方法例:dt = Date.parseDate(2006-01-15 3:20:01 PM, Y-m-d h:i:s A ); add( String interval, Number value ) : Date增加时间段,String interval在Data类中已定义Date.MILLI = ms;Date.SECOND = s;Date.MINUTE = mi;Date.HOUR = h;Date.DAY = d;Date.MONTH = mo;Date.YEAR = y;例var dt2 = new Date(10/1/2006).add(Date.DAY, -5); between( Date start, Date end ) : Boolean是否在两个指定的时间之间clearTime( Boolean clone ) : Date清除时间信息,如果clone为真,则克隆自已并返回新Date,本身的值并不改变,反之则修改自身的值clone() : Date克隆format( String format ) : String格式化时间d 两位数的日期 01 至 31D 三字母的星期名 Mon 至 Sunj 一位数的日期 1 至 31l 完整的星期名 Sunday 至 SaturdayS 日期的英文顺序刻词尾,两个字符 st, nd, rd or th.w 一周中的第几天 0 (星期天) 至 6 (星期六)z 一年中的第几天 0 至 364 (闰年365 )W ISO-8601 星期数, 周一算一个星期的开始 1 至 53F 月的完整英文名 January 至 Decemberm 月,以0前导 01 至 12M 三字母的简写月名 Jan 至 Decn 月 1 至 12t 本月有多少天 28 至 31L 是否闰年 1/0Y 完整的年份 例: 1999 或 2003y 年的后两位 例: 99 或 03a 上午/下午小写 am 或 pmA 上午/下午大写 AM 或 PMg 小时/12小时制 1 至 12G 小时/24小时制 0 至 23h 小时/12小时制 01 至 12H 小时/24小时制 00 至 23i 分钟 00 至 59s 秒 00 至 59u 毫秒 001 至 999O 时区,与格林威治标准时间之差 例: +0200T 时区简写 例: EST, MDT .Z 时区间距 -43200 至 50400其中Date类内置了几种格式Date.patterns = ISO8601Long:Y-m-d H:i:s, ISO8601Short:Y-m-d, ShortDate: n/j/Y, LongDate: l, F d, Y, FullDateTime: l, F d, Y g:i:s A, MonthDay: F d, ShortTime: g:i A, LongTime: g:i:s A, SortableDateTime: Y-m-dTH:i:s, UniversalSortableDateTime: Y-m-d H:i:sO, YearMonth: F, Y;当然ISO8601Long和ISO8601Short还是非常招人喜欢的例:dt.format(Date.patterns.ISO8601Long);dt.format(Y-m-d H:i:s);getDayOfYear() : Number一年中的第几天,从0开始getDaysInMonth() : Number本月有多少天,getElapsed( Date date ) : Number当前日期对象与date之间相差的毫秒数getFirstDateOfMonth() : Date本月的第一天getFirstDayOfMonth() : Number本月第一天是星期几getGMTOffset() : String时区信息(见格式定义中的O)getFirstDateOfMonth() : Date本月最后一天getFirstDayOfMonth() : Number本月最后一天是星期几getSuffix() : String日期后导符(见格式定义中的S)getTimezone() : String时区(见T)getWeekOfYear() : Number一年中的第几周(见W)isLeapYear() : Boolean是否闰年Function类createCallback(/*args.*/) : Function创建回叫方法createDelegate( Object obj, Array args, Boolean/Number appendArgs ) :创建委托这两个记法除了传参方式不同,看不出有什么差异都是调用method.apply,createCallback可以看作一个简化版的createDelegatecreateCallback=return method.apply(window, args);createDelegate=return method.apply(obj | window, callArgs);前者参数比较简单,直接传过去了,后者的规则比较复杂点,如果appendArgs为真,args将附加在参数列表之后,如果是数值,args将在参数列表的appendargs位置插入,其它情况下原参将不起作用例:var fn = func1.createDelegate(scope, arg1,arg2, true) /fn(a,b,c) = scope.func1(a,b,c,arg1,arg2); var fn = func1.createDelegate(scope, arg1,arg2) /fn(a,b,c) = scope.func1(arg1,arg2); var fn = func1.createDelegate(scope, arg1,arg2, 1) /fn(a,b,c) = scope.func1(a,arg1,arg2,b,c); var fn = func1.createCallback(arg1, arg2); /fn() = func1(arg1, arg2) createCallback : function(/*args.*/) createInterceptor( Function fcn, Object scope ) : Function创建阻断方法,如果fcn返回false,原方法将不会被执行createSequence( Function fcn, Object scope ) : Function创建组合方法,执行原方法+fcndefer( Number millis, Object obj, Array args, Boolean/Number appendArgs ):Number定时执行，隔millis毫秒后执行原方法EXT核心API详解(三)-Ext.ElementExt.Element类Element( String/HTMLElement element, Boolean forceNew )由id或DOM节点创建Element对象Element.fly( String/HTMLElement el, String named ) : Element由id或DOM节点创建一个全局共享的活动元素,可由named命名以避免可能的冲突Element.get( Mixed el ) : Element由id或DOM节点或已存在的Element得到一个Ext.Element对象addClass( String/Array className ) : Ext.Element为元素添加一个或多个css类名addClassOnClick( String className ) : Ext.Element为点击事件添加和移除css类addClassOnFocus( String className ) : Ext.Element为得到和失去焦点添加和移除css类addClassOnOver( String className, Boolean preventFlicker ) : Ext.Element为鼠标移入移出事件添加和移除css类(该方法未实际使用preventFlicker参数)addKeyListener( Number/Array/Object/String key, Function fn, Object scope ) : Ext.KeyMap为对象添加按键侦听 key由数值或字符串或key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)这样的对象或他们的数组组成addKeyMap( Object config ) : Ext.KeyMap功能同addKeyListener,只是传参方式不同例:el.addKeyMap(key : ab,ctrl : true,fn: fn,scope:el );和el.addKeyListener(key:ab,ctrl:true,fn,el);是等价的,都是在 按下ctral+a或ctrl+b后呼叫fnaddListener( String eventName, Function fn, Object scope, Object options ) : void定义事件侦听,eventName:事件名,fn:事件处理方法,scrope:范围,其中options的定义比较复杂,可以包含以下属性scope Object : 处理fn的范围delegate String : 一个简单选择器(过滤目标或寻找目标的子孙节点)stopEvent Boolean : 阻止事件,等于preventDefault+stopPropagationpreventDefault Boolean : 阻止默认活动stopPropagation Boolean : 阻止事件冒泡normalized Boolean :设为flase将允许浏览器事件替代Ext.EventObjectdelay Number : 延时多少毫秒后发生single Boolean : 只运行一次buffer Number : 在Ext.util.DelayedTask中预定事件当然,还可能自定义参数以传入functionalignTo( Mixed element, String position, Array offsets, Boolean/Object animate ) : Ext.Element将el对齐到element,positon,指示对齐的位置,可选以下定义tl 左上角(默认)t 上居中 tr 右上角l 左边界的中央c 居中r 右边界的中央bl 左下角b 下居中br 右下角position还可以使用?约束移动不能超出窗口offsets 偏移量,以象素为单位animate 详见animate定义例:div1.alignTo(div2,c-bl?,20,0,true);采用默认动画将div1的最中央对齐到div2的左下角,并右移20个象素,且不能超出窗口anchorTo( Mixed element, String position, Array offsets, Boolean/Object animate, Boolean/Number monitorScroll, Function callback ) : Ext.Element功能和alignTo类似,只是当窗口重定义大小的时候也会引发重对齐事件monitorScroll参数说明是否需要监视滚动条行为,如果定义为数值则是定义的延时,单位为毫秒,默认是50ms,callback定义了animate完成后的回叫方法animate( Object args, Float duration, Function onComplete, String easing, String animType ) : Ext.Element执行动画.args:目标duration:时间间隔.默认是0.35Function:完成后的回叫方法easing:行为方法 默认值是:easeOut,可选值在ext_base中找到,但没有说明,以下内容从yahoo ui中找到的easeNone:匀速easeIn:开始慢且加速easeOut:开始快且减速easeBoth:开始慢且减速easeInStrong:开始慢且加速,t的四次方easeOutStrong:开始快且减速,t的四次方easeBothStrong:开始慢且减速,t的四次方elasticIn:elasticOut:elasticBoth:backIn:backOut:backBoth:bounceIn:bounceOut:bounceBoth:太多,慢慢体会吧animType:定义动画类型,默认值run 可选值:color/motion/scrollappendChild( String/HTMLElement/Array/Element/CompositeElement el ) : Ext.Element添加子元素el(el须已存在)appendTo( Mixed el ) : Ext.Element将当前元素添加到elapplyStyles( String/Object/Function styles ) : Ext.Element应用样式,styles是width:100px这样的字符串或width:100px这样的对象,function是指返回这样的字串和对象的函数,这是一个没有用的批示,因为任何传参的地方都可以是返回要求类型的function.另见setStyleautoHeight( Boolean animate, Float duration, Function onComplete, String easing ) : Ext.Element自适应高度,参数都是老相识了,惟一需要注意的是这个方法使用了setTimeout,高度不会马上变更blur() : Ext.Element失去焦点,忽略所有的异常boxWrap( String class ) : Ext.Element用一个指定样式class的div将当前元素包含起来,class默认值为x-boxcenter( Mixed centerIn ) : voidalignTo的简华版.相当于alignTo(centerIn | document, c-c),当前元素的中心对齐到centerIn元素的中心child( String selector, Boolean returnDom ) : HTMLElement/Ext.Element依selector选择子孙节点,依returnDom不同批示返回html元素还是ext元素,未定义或false时返回Ext.Elementclean( Boolean forceReclean ) : void清除无用的空白文本节点(我喜欢这个想法)clearOpacity() : Ext.Element清除当前元素样式中不通用元素,清除ie中的filter,清除FF中的opacity/-moz-opacity/-khtml-opacityclearPositioning( String value ) : Ext.Element清除定位,恢复到默认值,相当于this.setStyle(left: value,right: value,top: value,bottom: value,z-index: ,position : static);clip() : Ext.Element裁剪溢出部分,用unclip()恢复contains( HTMLElement/String el ) : Boolean当前元素中是否存在elcreateChild( Object config, HTMLElement insertBefore, Boolean returnDom ) : Ext.Element创建一个新的子节点config :DomHelper元素对象,如果没有特别指明tag,将使用div做默认tag,详情参见DomHelper,如果未定义insertBefore,则追加createProxy( String/Object config, String/HTMLElement renderTo, Boolean matchBox ) : Ext.Element创建一个代理元素config:代理元素的类名或DomHelper config对象renderTo:将要绘制代理元素的html element或idmatchBox:是否对齐createShim() : Ext.Element在当前元素之前创建一个classname为ext-shim的iframe,有什么用?down( String selector, Boolean returnDom ) : HTMLElement/Ext.Element通过样式选择器selector选择子孙节点enableDisplayMode( String display ) : Ext.ElementsetVisibilityMode的简便方法findParent( String selector, Number/Mixed maxDepth, Boolean returnEl ) : HTMLElement通过简单选择器selector寻找祖先节点 ,直到maxDepth(元素maxDepth默认为10,也可以是指定的DOM 节点),找不到返回nullfindParentNode( String selector, Number/Mixed maxDepth, Boolean returnEl ) : HTMLElement从父元素开始使用简单选择器selector选择DOM节点first( String selector, Boolean returnDom ) : Ext.Element/HTMLElement得到第一个符合selector条件的子节点,跳过文本节点focus() : Ext.Element得到焦点getAlignToXY( Mixed element, String position, Array offsets ) : Array得到当前元素按position规则对齐到element时的XY坐标值 position/offsets参数参见alignTo方法getAnchorXY( String anchor, Object size, Boolean local ) : Array得到当前元素锚点指定的坐标值 anchor定义参见alignTo方法,默认为cgetAttributeNS( String namespace, String name ) : String得到使用了命名空间namespace的属性name之值,getBorderWidth( String side ) : Number得到side指定的边框之和,side可以是t, l, r, b或他们的任意组合,比如getBorderWidth(lr)就是得到左边框和右边框之和getBottom( Boolean local ) : Number得到当前元素的底部纵坐标,元素纵坐标+元素高度getBox( Boolean contentBox, Boolean local ) : Object得到当前元素的box对象:x,y,width,heightgetCenterXY() : Array如果当前元素要居中对齐时的横纵坐标值,等价getAlignToXY(document, c-c)getColor( String attr, String defaultValue, String prefix ) : void得到当前元素指定attr的颜色值,如果没指定,返回defualtValue,比较郁闷的是明明不是void为什么api中批示是一个void?应该是个字符串getComputedHeight() : Number得到计算过的高度,得到offsetHeight或css中定义的height值之一,如果使用了padding/borders,也会计算进去getComputedWidth() : Number见getComputedHeightgetFrameWidth( String sides ) : Number得到sides定义的border宽度和padding定义的宽度之和,side定义见getBorderWidthgetHeight( Boolean contentHeight ) : Number返回元素的offsetHeightgetLeft( Boolean local ) : Number得到横坐标getMargins( String sides ) : Object/Number如果没有定义sides,则返回一个含有left,top,width,height对象,反之返回side指定的宽度,side定义见getBorderWidthgetOffsetsTo( Mixed element ) : Array计算从element到当前元素的偏移量getPadding( String side ) : Number得到由side指定的padding之和getPositioning() : Object得到当前元素的位置信息 返回含以下属性的对象position,left,right,top,bottom,z-indexgetRegion() : Region得到当前元素的区域信息 返回含有以下属性的Ext.lib.Region对象top, left, bottom, rightgetRight( Boolean local ) : Number右边界值getScroll() : Object得到一个批示滚动条位置的对象left, topgetSize( Boolean contentSize ) : Object得到宽度和高度组成的对象信息width,heightgetStyle( String property ) : String得到指定的样式值 getStyles简化版getStyles( String style1, String style2, String etc. ) : Object得到由参数组成的对象例:el.getStyles(color, font-size, width) 可能返回 color: #FFFFFF, font-size: 13px, width: 100pxgetTop( Boolean local ) : Number得到顶点纵坐 标getUpdater() : Ext.Updater得到当前元素的Updater对象,参见Ext.Updater类getValue( Boolean asNumber ) : String/Number得到value属性的值getViewSize() : Object得到clientHeight和clientWidth信息给成的对象width,heightgetWidth( Boolean contentWidth ) : Number.这样的方法真多getX() : NumbergetXY() : ArraygetY() : Array得到页面偏移量,也就是绝对坐标hasClass( String className ) : Boolean样式类className 存在于当前元素的dom 节点中hide( Boolean/Object animate ) : Ext.Element隐藏当前元素hover( Function overFn, Function outFn, Object scope ) : Ext.Element设置鼠标移入移出事件initDD( String group, Object config, Object overrides ) : Ext.dd.DDinitDDProxy( String group, Object config,